immutable_java_home.rb

# frozen_string_literal: true

# Cloud Foundry Java Buildpack
# Copyright 2013-2020 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require 'java_buildpack/component'
require 'java_buildpack/util/qualify_path'

module JavaBuildpack
  module Component

    # An abstraction around the +JAVA_HOME+ path used by the droplet.  This implementation is immutable and should be
    # passed to any component that is not a jre.
    #
    # A new instance of this type should be created once for the application.
    class ImmutableJavaHome
      include JavaBuildpack::Util

      # Creates a new instance of the java home abstraction
      #
      # @param [MutableJavaHome] delegate the instance of +MutableJavaHome+ to use as a delegate for +root+ calls
      def initialize(delegate, droplet_root)
        @delegate     = delegate
        @droplet_root = droplet_root
      end

      # Returns the path of +JAVA_HOME+ as an environment variable formatted as +JAVA_HOME=$PWD/<value>+
      #
      # @return [String] the path of +JAVA_HOME+ as an environment variable
      def as_env_var
        "JAVA_HOME=#{qualify_path root}"
      end

      # Whether or not the version of Java is 8 or later
      #
      # @return [Boolean] +true+ iff the version is 1.8.0 or later
      def java_8_or_later?
        @delegate.java_8_or_later?
      end

      # Whether or not the version of Java is 9 or later
      #
      # @return [Boolean] +true+ iff the version is 9.0.0 or later
      def java_9_or_later?
        @delegate.java_9_or_later?
      end

      # Whether or not the version of Java is 10 or later
      #
      # @return [Boolean] +true+ iff the version is 10.0.0 or later
      def java_10_or_later?
        @delegate.java_10_or_later?
      end

      # @return [Pathname] the root of the droplet's +JAVA_HOME+
      def root
        @delegate.root
      end

      # @return # @return [JavaBuildpack::Util::TokenizedVersion] the tokenized droplet's +VERSION+
      def version
        @delegate.version
      end

    end

  end
end