Package org.apache.maven.api.settings

Class IdentifiableBase

java.lang.Object
org.apache.maven.api.settings.TrackableBase
org.apache.maven.api.settings.IdentifiableBase
All Implemented Interfaces:
Serializable, InputLocationTracker
Direct Known Subclasses:
Mirror, Profile, Proxy, RepositoryBase, Server
@Experimental @Generated @ThreadSafe @Immutable public class IdentifiableBase extends TrackableBase implements Serializable, InputLocationTracker
Base class for Mirror, Profile, Proxy and Server.
See Also:

  • Constructor Details

  • Method Details

    • getId

      public String getId()
      Item identifier.
      Returns:
      a String

    • getLocation

      public InputLocation getLocation(Object key)
      Gets the location of the specified field in the input source.
      Specified by:
      getLocation in interface InputLocationTracker
      Overrides:
      getLocation in class TrackableBase

    • getLocationKeys

      public Set<Object> getLocationKeys()
      Gets the keys of the locations of the input source.
      Overrides:
      getLocationKeys in class TrackableBase

    • with

      @Nonnull public IdentifiableBase.Builder with()
      Creates a new builder with this object as the basis.
      Overrides:
      with in class TrackableBase
      Returns:
      a Builder

    • withId

      @Nonnull public IdentifiableBase withId(String id)
      Creates a new IdentifiableBase instance using the specified id.
      Parameters:
      id - the new String to use
      Returns:
      a IdentifiableBase with the specified id

    • newInstance

      @Nonnull public static IdentifiableBase newInstance()
      Creates a new IdentifiableBase instance. Equivalent to newInstance(true).
      Returns:
      a new IdentifiableBase
      See Also:

    • newInstance

      @Nonnull public static IdentifiableBase newInstance(boolean withDefaults)
      Creates a new IdentifiableBase instance using default values or not. Equivalent to newBuilder(withDefaults).build().
      Parameters:
      withDefaults - the boolean indicating whether default values should be used
      Returns:
      a new IdentifiableBase

    • newBuilder

      @Nonnull public static IdentifiableBase.Builder newBuilder()
      Creates a new IdentifiableBase builder instance. Equivalent to newBuilder(true).
      Returns:
      a new Builder
      See Also:

    • newBuilder

      @Nonnull public static IdentifiableBase.Builder newBuilder(boolean withDefaults)
      Creates a new IdentifiableBase builder instance using default values or not.
      Parameters:
      withDefaults - the boolean indicating whether default values should be used
      Returns:
      a new Builder

    • newBuilder

      @Nonnull public static IdentifiableBase.Builder newBuilder(IdentifiableBase from)
      Creates a new IdentifiableBase builder instance using the specified object as a basis. Equivalent to newBuilder(from, false).
      Parameters:
      from - the IdentifiableBase instance to use as a basis
      Returns:
      a new Builder

    • newBuilder

      @Nonnull public static IdentifiableBase.Builder newBuilder(IdentifiableBase from, boolean forceCopy)
      Creates a new IdentifiableBase builder instance using the specified object as a basis.
      Parameters:
      from - the IdentifiableBase instance to use as a basis
      forceCopy - the boolean indicating if a copy should be forced
      Returns:
      a new Builder