Enum Class ReferenceType

java.lang.Object
java.lang.Enum<ReferenceType>
de.espirit.firstspirit.access.store.ReferenceType
All Implemented Interfaces:
Serializable, Comparable<ReferenceType>, java.lang.constant.Constable

public enum ReferenceType extends Enum<ReferenceType>
Support for reference types and prefixes.
Since:
4.0.120
  • Enum Constant Details

    • PAGEREF

      public static final ReferenceType PAGEREF
      Reference type for PageRef elements, prefix is "pageref".
      Since:
      4.0.120
    • PAGEREFFOLDER

      public static final ReferenceType PAGEREFFOLDER
      Reference type for PageRefFolder elements, prefix is "pagefolder".
      Since:
      4.0.120
    • DOCUMENTGROUP

      public static final ReferenceType DOCUMENTGROUP
      Reference type for DocumentGroup elements, prefix is "docgroup".
      Since:
      4.0.120
    • MEDIA

      public static final ReferenceType MEDIA
      Reference type for Media elements, prefix is "media".
      Since:
      4.0.120
    • MEDIAFOLDER

      public static final ReferenceType MEDIAFOLDER
      Reference type for MediaFolder elements, prefix is "mediafolder".
      Since:
      4.0.120
    • SCRIPT

      public static final ReferenceType SCRIPT
      Reference type for Script elements, prefix is "script".
      Since:
      4.0.120
    • MASTERTEMPLATE

      public static final ReferenceType MASTERTEMPLATE
      Reference type for MasterTemplate elements, prefix is "template".
      Since:
      4.2.414
    • LINKTEMPLATE

      public static final ReferenceType LINKTEMPLATE
      Reference type for LinkTemplate elements, prefix is "linktemplate".
      Since:
      4.2.414
    • TEMPLATE

      public static final ReferenceType TEMPLATE
      Reference type for FormatTemplate elements, prefix is "template".
      Since:
      4.0.120
  • Method Details

    • values

      public static ReferenceType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ReferenceType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • typeOf

      @Nullable public static @Nullable ReferenceType typeOf(String referenceOrTypeName)
      Since:
      4.0.120
    • typeOf

      @Nullable public static @Nullable ReferenceType typeOf(IDProvider.UidType uidType)
      Determine the reference type based on the given uid type.
      Parameters:
      uidType - The UID type to match.
      Returns:
      The matching reference type or null.
      Since:
      4.2.403
    • prefix

      public String prefix()
      Provides the prefix (including the colon) designating reference types.
      Returns:
      The prefix.
      Since:
      4.0.120
    • type

      public String type()
      Provides the type's name.
      Returns:
      The type's name.
      Since:
      4.0.120
    • isTypeOf

      public boolean isTypeOf(String referenceName)
      Tests, whether the given reference name is of the questioned type.
      Parameters:
      referenceName - The reference name to test.
      Returns:
      true, if the reference name matches the type's criteria.
      Since:
      4.0.120
    • strip

      public String strip(String referenceName)
      Strip the prefix of the questioned type from the given reference name. If the reference name does not match the type's criteria, returns null.
      Parameters:
      referenceName - The reference name to be stripped.
      Returns:
      The stripped name or null.
      Since:
      4.0.120
    • getUidType

      public IDProvider.UidType getUidType()
      Since:
      4.2.38