Class JvmMavenProtocPluginBean

java.lang.Object
io.github.ascopes.protobufmavenplugin.dependencies.MavenArtifact
io.github.ascopes.protobufmavenplugin.plugins.JvmMavenProtocPlugin
io.github.ascopes.protobufmavenplugin.plugins.JvmMavenProtocPluginBean
All Implemented Interfaces:
ProtocPlugin
@Generated(from="JvmMavenProtocPlugin", generator="Modifiables") @Generated({"Modifiables.generator","JvmMavenProtocPlugin"}) public class JvmMavenProtocPluginBean extends JvmMavenProtocPlugin
A modifiable implementation of the JvmMavenProtocPlugin type.

Use the constructor to create new modifiable instances. You may even extend this class to add some convenience methods, however most of the methods in this class are final to preserve safety and predictable invariants.

JvmMavenProtocPluginBean is not thread-safe

  • Constructor Details

    • JvmMavenProtocPluginBean

      public JvmMavenProtocPluginBean()

  • Method Details

    • getOptions

      public @Nullable String getOptions()
      Returns:
      value of options attribute, may be null

    • getOutputDirectory

      public @Nullable Path getOutputDirectory()
      Returns:
      value of outputDirectory attribute, may be null

    • isRegisterAsCompilationRoot

      public @Nullable Boolean isRegisterAsCompilationRoot()
      Returns:
      value of registerAsCompilationRoot attribute, may be null

    • getOrder

      public int getOrder()
      Returns:
      assigned or, otherwise, newly computed, not cached value of order attribute

    • isSkip

      public boolean isSkip()
      Returns:
      assigned or, otherwise, newly computed, not cached value of skip attribute

    • getGroupId

      public String getGroupId()
      Specified by:
      getGroupId in class MavenArtifact
      Returns:
      value of groupId attribute, may be null

    • getArtifactId

      public String getArtifactId()
      Specified by:
      getArtifactId in class MavenArtifact
      Returns:
      value of artifactId attribute, may be null

    • getType

      public @Nullable String getType()
      Specified by:
      getType in class MavenArtifact
      Returns:
      value of type attribute, may be null

    • getClassifier

      public @Nullable String getClassifier()
      Specified by:
      getClassifier in class MavenArtifact
      Returns:
      value of classifier attribute, may be null

    • getVersion

      public @NonNull String getVersion()
      Specified by:
      getVersion in class JvmMavenProtocPlugin
      Returns:
      value of version attribute, may be null

    • getJvmArgs

      public @Nullable List<String> getJvmArgs()
      Specified by:
      getJvmArgs in class JvmMavenProtocPlugin
      Returns:
      modifiable list jvmArgs

    • getJvmConfigArgs

      public @Nullable List<String> getJvmConfigArgs()
      Specified by:
      getJvmConfigArgs in class JvmMavenProtocPlugin
      Returns:
      modifiable list jvmConfigArgs

    • getMainClass

      public @Nullable String getMainClass()
      Specified by:
      getMainClass in class JvmMavenProtocPlugin
      Returns:
      value of mainClass attribute, may be null

    • clear

      public void clear()
      Clears the object by setting all attributes to their initial values.

    • from

      public JvmMavenProtocPluginBean from(MavenArtifact instance)
      Fill this modifiable instance with attribute values from the provided MavenArtifact instance.
      Parameters:
      instance - The instance from which to copy values

    • from

      public JvmMavenProtocPluginBean from(ProtocPlugin instance)
      Fill this modifiable instance with attribute values from the provided ProtocPlugin instance.
      Parameters:
      instance - The instance from which to copy values

    • from

      public JvmMavenProtocPluginBean from(JvmMavenProtocPlugin instance)
      Fill this modifiable instance with attribute values from the provided JvmMavenProtocPlugin instance.
      Parameters:
      instance - The instance from which to copy values

    • from

      public JvmMavenProtocPluginBean from(JvmMavenProtocPluginBean instance)
      Fill this modifiable instance with attribute values from the provided JvmMavenProtocPlugin instance. Regular attribute values will be overridden, i.e. replaced with ones of an instance. Any of the instance's absent optional values will not be copied (will not override current values). Collection elements and entries will be added, not replaced.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this for use in a chained invocation

    • setOptions

      public void setOptions(@Nullable String options)
      Assigns a value to the options attribute.
      Parameters:
      options - The value for options, can be null

    • setOutputDirectory

      public void setOutputDirectory(@Nullable Path outputDirectory)
      Assigns a value to the outputDirectory attribute.
      Parameters:
      outputDirectory - The value for outputDirectory, can be null

    • setRegisterAsCompilationRoot

      public void setRegisterAsCompilationRoot(@Nullable Boolean registerAsCompilationRoot)
      Assigns a value to the registerAsCompilationRoot attribute.
      Parameters:
      registerAsCompilationRoot - The value for registerAsCompilationRoot, can be null

    • setOrder

      public void setOrder(int order)
      Assigns a value to the order attribute.

      If not set, this attribute will have a default value returned by the initializer of order.

      Parameters:
      order - The value for order

    • setSkip

      public void setSkip(boolean skip)
      Assigns a value to the skip attribute.

      If not set, this attribute will have a default value returned by the initializer of skip.

      Parameters:
      skip - The value for skip

    • setGroupId

      public void setGroupId(String groupId)
      Assigns a value to the groupId attribute.
      Parameters:
      groupId - The value for groupId, can be null

    • setArtifactId

      public void setArtifactId(String artifactId)
      Assigns a value to the artifactId attribute.
      Parameters:
      artifactId - The value for artifactId, can be null

    • setType

      public void setType(@Nullable String type)
      Assigns a value to the type attribute.
      Parameters:
      type - The value for type, can be null

    • setClassifier

      public void setClassifier(@Nullable String classifier)
      Assigns a value to the classifier attribute.
      Parameters:
      classifier - The value for classifier, can be null

    • setVersion

      public void setVersion(@NonNull String version)
      Assigns a value to the version attribute.
      Parameters:
      version - The value for version, can be null

    • addJvmArgs

      public void addJvmArgs(String element)
      Adds one element to jvmArgs list.
      Parameters:
      element - The jvmArgs element

    • addJvmArgs

      public final void addJvmArgs(@Nullable String... elements)
      Adds elements to jvmArgs list.
      Parameters:
      elements - An array of jvmArgs elements

    • setJvmArgs

      public void setJvmArgs(@Nullable List<String> elements)
      Sets or replaces all elements for jvmArgs list.
      Parameters:
      elements - An iterable of jvmArgs elements, can be null

    • addAllJvmArgs

      public void addAllJvmArgs(@Nullable Iterable<@Nullable String> elements)
      Adds elements to jvmArgs list.
      Parameters:
      elements - An iterable of jvmArgs elements

    • addJvmConfigArgs

      public void addJvmConfigArgs(String element)
      Adds one element to jvmConfigArgs list.
      Parameters:
      element - The jvmConfigArgs element

    • addJvmConfigArgs

      public final void addJvmConfigArgs(@Nullable String... elements)
      Adds elements to jvmConfigArgs list.
      Parameters:
      elements - An array of jvmConfigArgs elements

    • setJvmConfigArgs

      public void setJvmConfigArgs(@Nullable List<String> elements)
      Sets or replaces all elements for jvmConfigArgs list.
      Parameters:
      elements - An iterable of jvmConfigArgs elements, can be null

    • addAllJvmConfigArgs

      public void addAllJvmConfigArgs(@Nullable Iterable<@Nullable String> elements)
      Adds elements to jvmConfigArgs list.
      Parameters:
      elements - An iterable of jvmConfigArgs elements

    • setMainClass

      public void setMainClass(@Nullable String mainClass)
      Assigns a value to the mainClass attribute.
      Parameters:
      mainClass - The value for mainClass, can be null

    • groupIdIsSet

      public final boolean groupIdIsSet()
      Returns true if the required attribute groupId is set.
      Returns:
      true if set

    • artifactIdIsSet

      public final boolean artifactIdIsSet()
      Returns true if the required attribute artifactId is set.
      Returns:
      true if set

    • versionIsSet

      public final boolean versionIsSet()
      Returns true if the required attribute version is set.
      Returns:
      true if set

    • orderIsSet

      public final boolean orderIsSet()
      Returns true if the default attribute order is set.
      Returns:
      true if set

    • skipIsSet

      public final boolean skipIsSet()
      Returns true if the default attribute skip is set.
      Returns:
      true if set

    • jvmArgsIsSet

      public final boolean jvmArgsIsSet()
      Returns true if the jvmArgs has not been initialized and will default to an empty list.
      Returns:
      true if set

    • jvmConfigArgsIsSet

      public final boolean jvmConfigArgsIsSet()
      Returns true if the jvmConfigArgs has not been initialized and will default to an empty list.
      Returns:
      true if set

    • unsetGroupId

      public final void unsetGroupId()
      Reset an attribute to its initial value.

    • unsetArtifactId

      public final void unsetArtifactId()
      Reset an attribute to its initial value.

    • unsetVersion

      public final void unsetVersion()
      Reset an attribute to its initial value.

    • unsetOrder

      public final void unsetOrder()
      Reset an attribute to its initial value.

    • unsetSkip

      public final void unsetSkip()
      Reset an attribute to its initial value.

    • isInitialized

      public final boolean isInitialized()
      Returns true if all required attributes are set, indicating that the object is initialized.
      Returns:
      true if set

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of JvmMavenProtocPluginBean that have equal attribute values. An uninitialized instance is equal only to itself.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: options, outputDirectory, registerAsCompilationRoot, order, skip, groupId, artifactId, type, classifier, version, jvmArgs, jvmConfigArgs, mainClass.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value