Class PathProtocPluginBean

java.lang.Object
io.github.ascopes.protobufmavenplugin.plugins.PathProtocPluginBean
All Implemented Interfaces:
OptionalProtocPlugin, PathProtocPlugin, ProtocPlugin
@Generated(from="PathProtocPlugin", generator="Modifiables") @Generated({"Modifiables.generator","PathProtocPlugin"}) public class PathProtocPluginBean extends Object implements PathProtocPlugin
A modifiable implementation of the PathProtocPlugin 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.

PathProtocPluginBean is not thread-safe

  • Constructor Details

    • PathProtocPluginBean

      public PathProtocPluginBean()

  • Method Details

    • getOptions

      public @Nullable String getOptions()
      Specified by:
      getOptions in interface ProtocPlugin
      Returns:
      value of options attribute, may be null

    • getOutputDirectory

      public @Nullable Path getOutputDirectory()
      Specified by:
      getOutputDirectory in interface ProtocPlugin
      Returns:
      value of outputDirectory attribute, may be null

    • isRegisterAsCompilationRoot

      public @Nullable Boolean isRegisterAsCompilationRoot()
      Specified by:
      isRegisterAsCompilationRoot in interface ProtocPlugin
      Returns:
      value of registerAsCompilationRoot attribute, may be null

    • getOrder

      public int getOrder()
      Specified by:
      getOrder in interface ProtocPlugin
      Returns:
      assigned or, otherwise, newly computed, not cached value of order attribute

    • isSkip

      public boolean isSkip()
      Specified by:
      isSkip in interface ProtocPlugin
      Returns:
      assigned or, otherwise, newly computed, not cached value of skip attribute

    • isOptional

      public boolean isOptional()
      Specified by:
      isOptional in interface OptionalProtocPlugin
      Returns:
      assigned or, otherwise, newly computed, not cached value of optional attribute

    • getName

      public String getName()
      Specified by:
      getName in interface PathProtocPlugin
      Returns:
      value of name attribute, may be null

    • clear

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

    • from

      public PathProtocPluginBean 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 PathProtocPluginBean from(PathProtocPlugin instance)
      Fill this modifiable instance with attribute values from the provided PathProtocPlugin instance.
      Parameters:
      instance - The instance from which to copy values

    • from

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

    • from

      public PathProtocPluginBean from(PathProtocPluginBean instance)
      Fill this modifiable instance with attribute values from the provided PathProtocPlugin 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).
      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

    • setOptional

      public void setOptional(boolean optional)
      Assigns a value to the optional attribute.

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

      Parameters:
      optional - The value for optional

    • setName

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

    • nameIsSet

      public final boolean nameIsSet()
      Returns true if the required attribute name 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

    • optionalIsSet

      public final boolean optionalIsSet()
      Returns true if the default attribute optional is set.
      Returns:
      true if set

    • unsetName

      public final void unsetName()
      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.

    • unsetOptional

      public final void unsetOptional()
      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 PathProtocPluginBean 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, optional, name.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Generates a string representation of this PathProtocPlugin. If uninitialized, some attribute values may appear as question marks.
      Overrides:
      toString in class Object
      Returns:
      A string representation