Package de.espirit.firstspirit.access.store.templatestore.gom

Class GomCategoryEntry

java.lang.Object
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
de.espirit.firstspirit.access.store.templatestore.gom.GomCategoryEntry
All Implemented Interfaces:
GomCheckable, GomElement, GomProjectEntry, Serializable
@NonExtendable public class GomCategoryEntry extends AbstractGomElement implements GomProjectEntry, GomCheckable
GOM representation of a category
Since:
4.2.5
See Also:

  • Field Details

    • REFERENCENAME_PATTERN

      public static final String REFERENCENAME_PATTERN
      Regular expression for valid reference names
      Since:
      4.2.5
      See Also:

    • PATTERN

      public static final Pattern PATTERN
      Compiled pattern for valid reference names
      Since:
      4.2.5

    • TAG

      public static final String TAG
      The tag of this component
      Since:
      4.2.5
      See Also:

  • Constructor Details

    • GomCategoryEntry

      public GomCategoryEntry()

  • Method Details

    • on

      @NotNull public static @NotNull GomCategoryEntry on(String category)
      Creates a new instance with the given category name
      Parameters:
      category - the name of the category
      Returns:
      a new instance, never null
      Since:
      4.2.9

    • getDefaultTag

      protected String getDefaultTag()
      Description copied from class: AbstractGomElement
      Return the default tag for a gom element.
      Specified by:
      getDefaultTag in class AbstractGomElement
      Returns:
      The elements default tag.

    • asConstraint

      public ProjectConstraint asConstraint()
      Description copied from interface: GomProjectEntry
      Get a constraint representation of this entry.
      Specified by:
      asConstraint in interface GomProjectEntry
      Returns:
      The entry's constraint representation.

    • getName

      public String getName()
      The remote project category name
      Since:
      4.2.5

    • setName

      public void setName(String name)
      Sets the remote project category name
      Since:
      4.2.5

    • getSources

      @NotNull public @NotNull GomStoreFolderList getSources()
      Restrict access to specific folders (including sub-folders and store roots)
      Since:
      4.2.9

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • verify

      public void verify() throws IllegalStateException
      Description copied from interface: GomCheckable
      Verify the element to be fulfill its syntactic constraints.
      Specified by:
      verify in interface GomCheckable
      Throws:
      IllegalStateException - If the element is not correctly set up.

    • validate

      public void validate(GomCheckable.Context context) throws GomValidationError
      Description copied from interface: GomCheckable
      Validate the element against the given context.
      Specified by:
      validate in interface GomCheckable
      Parameters:
      context - The context to validate for, must not be null.
      Throws:
      GomValidationError - If the element is not plausible wrt. its context.