Package org.apache.maven.api.metadata

Class Plugin

java.lang.Object
org.apache.maven.api.metadata.Plugin
All Implemented Interfaces:
Serializable
@Experimental @Generated @ThreadSafe @Immutable public class Plugin extends Object implements Serializable
Mapping information for a single plugin within this group.
See Also:

  • Constructor Details

  • Method Details

    • getName

      public String getName()
      Display name for the plugin.
      Returns:
      a String

    • getPrefix

      public String getPrefix()
      The plugin invocation prefix (i.e. eclipse for eclipse:eclipse)
      Returns:
      a String

    • getArtifactId

      public String getArtifactId()
      The plugin artifactId
      Returns:
      a String

    • with

      @Nonnull public Plugin.Builder with()
      Creates a new builder with this object as the basis.
      Returns:
      a Builder

    • withName

      @Nonnull public Plugin withName(String name)
      Creates a new Plugin instance using the specified name.
      Parameters:
      name - the new String to use
      Returns:
      a Plugin with the specified name

    • withPrefix

      @Nonnull public Plugin withPrefix(String prefix)
      Creates a new Plugin instance using the specified prefix.
      Parameters:
      prefix - the new String to use
      Returns:
      a Plugin with the specified prefix

    • withArtifactId

      @Nonnull public Plugin withArtifactId(String artifactId)
      Creates a new Plugin instance using the specified artifactId.
      Parameters:
      artifactId - the new String to use
      Returns:
      a Plugin with the specified artifactId

    • newInstance

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

    • newInstance

      @Nonnull public static Plugin newInstance(boolean withDefaults)
      Creates a new Plugin 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 Plugin

    • newBuilder

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

    • newBuilder

      @Nonnull public static Plugin.Builder newBuilder(boolean withDefaults)
      Creates a new Plugin 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 Plugin.Builder newBuilder(Plugin from)
      Creates a new Plugin builder instance using the specified object as a basis. Equivalent to newBuilder(from, false).
      Parameters:
      from - the Plugin instance to use as a basis
      Returns:
      a new Builder

    • newBuilder

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