Package com.adobe.granite.haf.annotations

Enum ApiLink.SCOPE

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ApiLink.SCOPE>
    Enclosing class:
    ApiLink
    public static enum ApiLink.SCOPE
extends java.lang.Enum<ApiLink.SCOPE>
    Defines the scope in which the link will be serialized in.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BOTH
      The link will be serialized as part of both a main and a sub-entity.
      INLINE
      The link will only be serialized as part of a sub-entity.
      RESOURCE
      The link will only be serialized as part of a main entity.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean contains​(ApiLink.SCOPE scope)
      Determines if the current scope contains the passed in scope value.
      static ApiLink.SCOPE valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ApiLink.SCOPE[] 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

      • RESOURCE

        public static final ApiLink.SCOPE RESOURCE
        The link will only be serialized as part of a main entity.

      • INLINE

        public static final ApiLink.SCOPE INLINE
        The link will only be serialized as part of a sub-entity.

      • BOTH

        public static final ApiLink.SCOPE BOTH
        The link will be serialized as part of both a main and a sub-entity.

    • Method Detail

      • values

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

      • valueOf

        public static ApiLink.SCOPE 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

      • contains

        public boolean contains​(ApiLink.SCOPE scope)
        Determines if the current scope contains the passed in scope value. If the current scope is SCOPE.BOTH true is always returned. Otherwise a direct comparison of the current scope and the passed one is done.
        Parameters:
        scope - The scope value to test the current scope against.
        Returns:
        True is the current scope contains the passed in scope, false otherwise.