Package org.apache.maven.impl.cache

Record Class PartialCacheConfig

java.lang.Object
java.lang.Record
org.apache.maven.impl.cache.PartialCacheConfig
Record Components:
scope - the cache retention scope (nullable)
referenceType - the reference type to use for cache entries (nullable)
public record PartialCacheConfig(CacheRetention scope, Cache.ReferenceType referenceType) extends Record
Partial cache configuration that allows specifying only scope or reference type. Used for merging configurations from multiple selectors.

  • Constructor Details

    • PartialCacheConfig

      public PartialCacheConfig(CacheRetention scope, Cache.ReferenceType referenceType)
      Creates an instance of a PartialCacheConfig record class.
      Parameters:
      scope - the value for the scope record component
      referenceType - the value for the referenceType record component

  • Method Details

    • withScope

      public static PartialCacheConfig withScope(CacheRetention scope)
      Creates a partial configuration with only scope specified.

    • withReferenceType

      public static PartialCacheConfig withReferenceType(Cache.ReferenceType referenceType)
      Creates a partial configuration with only reference type specified.

    • complete

      public static PartialCacheConfig complete(CacheRetention scope, Cache.ReferenceType referenceType)
      Creates a complete partial configuration with both scope and reference type.

    • mergeWith

      public PartialCacheConfig mergeWith(PartialCacheConfig other)
      Merges this configuration with another, with this configuration taking precedence for non-null values.
      Parameters:
      other - the other configuration to merge with
      Returns:
      a new merged configuration

    • toComplete

      public CacheConfig toComplete()
      Converts this partial configuration to a complete CacheConfig, using defaults for missing values.
      Returns:
      a complete CacheConfig

    • isEmpty

      public boolean isEmpty()
      Checks if this configuration is empty (both values are null).

    • isComplete

      public boolean isComplete()
      Checks if this configuration is complete (both values are non-null).

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • scope

      public CacheRetention scope()
      Returns the value of the scope record component.
      Returns:
      the value of the scope record component

    • referenceType

      public Cache.ReferenceType referenceType()
      Returns the value of the referenceType record component.
      Returns:
      the value of the referenceType record component