Record Class ActivationSettings

java.lang.Object
java.lang.Record
org.apache.maven.execution.ActivationSettings
Record Components:
active - Should the target be active?
optional - Should the build continue if the target is not present?
recurse - Should the target be activated and its children be activated?
public record ActivationSettings(boolean active, boolean optional, boolean recurse) extends Record
Describes whether a target should be activated or not, and if that is required or optional.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActivationSettings(boolean active, boolean optional, boolean recurse)
    Creates an instance of a ActivationSettings record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    active()
    Returns the value of the active record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    optional()
    Returns the value of the optional record component.
    boolean
    recurse()
    Returns the value of the recurse record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ActivationSettings

      public ActivationSettings(boolean active, boolean optional, boolean recurse)
      Creates an instance of a ActivationSettings record class.
      Parameters:
      active - the value for the active record component
      optional - the value for the optional record component
      recurse - the value for the recurse record component

  • Method Details

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • active

      public boolean active()
      Returns the value of the active record component.
      Returns:
      the value of the active record component

    • optional

      public boolean optional()
      Returns the value of the optional record component.
      Returns:
      the value of the optional record component

    • recurse

      public boolean recurse()
      Returns the value of the recurse record component.
      Returns:
      the value of the recurse record component