Package com.adobe.cq.wcm.core.components.models

Enum Embed.Type

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Embed.Type>
    Enclosing interface:
    Embed
    public static enum Embed.Type
extends java.lang.Enum<Embed.Type>
    Enumeration of the supported embed input types.
    Since:
    com.adobe.cq.wcm.core.components.models 12.10.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EMBEDDABLE
      Embed type for input from an embeddable.
      HTML
      Embed type for input from a HTML snippet.
      URL
      Embed type for input from a URL.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Embed.Type fromString​(java.lang.String value)
      Given a String value, this method returns the enum's value that corresponds to the provided string representation.
      static Embed.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Embed.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • URL

        public static final Embed.Type URL
        Embed type for input from a URL.
        Since:
        com.adobe.cq.wcm.core.components.models 12.10.0

      • EMBEDDABLE

        public static final Embed.Type EMBEDDABLE
        Embed type for input from an embeddable.
        Since:
        com.adobe.cq.wcm.core.components.models 12.10.0

      • HTML

        public static final Embed.Type HTML
        Embed type for input from a HTML snippet.
        Since:
        com.adobe.cq.wcm.core.components.models 12.10.0

    • Method Detail

      • values

        public static Embed.Type[] 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 (Embed.Type c : Embed.Type.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Embed.Type 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

      • fromString

        public static Embed.Type fromString​(java.lang.String value)
        Given a String value, this method returns the enum's value that corresponds to the provided string representation. If no representation is found, null will be returned.
        Parameters:
        value - the string representation for which an enum value should be returned
        Returns:
        the corresponding enum value, if one was found, null otherwise
        Since:
        com.adobe.cq.wcm.core.components.models 12.10.0