Enum VanityMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<VanityMode>

    public enum VanityMode
    extends java.lang.Enum<VanityMode>
    Vanity mode to use when building URLs pointing to AEM pages.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALWAYS
      Always use vanity paths for AEM pages.
      EXTERNALIZE
      Only use vanity paths when externalizing URLs for AEM pages.
      NEVER
      Ignore vanity paths for AEM pages.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static VanityMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static VanityMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • NEVER

        public static final VanityMode NEVER
        Ignore vanity paths for AEM pages.
      • EXTERNALIZE

        public static final VanityMode EXTERNALIZE
        Only use vanity paths when externalizing URLs for AEM pages.
      • ALWAYS

        public static final VanityMode ALWAYS
        Always use vanity paths for AEM pages.
    • Method Detail

      • values

        public static VanityMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (VanityMode c : VanityMode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static VanityMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null