Package com.elide.model

Enum Class Visibility

java.lang.Object
java.lang.Enum<Visibility>
com.elide.model.Visibility
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Visibility>, Constable
public enum Visibility extends Enum<Visibility> implements com.google.protobuf.ProtocolMessageEnum
 Sets the visibility of a given object and its constituent properties, in circumstances where the object is served to
 a frontend client/agent. Depending on the visibility of a given property, it may or may not be emitted by an API
 service, or made available (or not) in the JS context.
Protobuf enum elide.model.Visibility

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    EXPORT
    Export visibility: expose this item to the outer invoking context.
    PACKAGE
    Package visibility: items or objects in the same package can access and address this item.
    PRIVATE
    Private visibility: only usable and addressable by itself, or associated items.
    PROTECTED
    Protected visibility: children and other associated objects can access or address this item.
    PUBLIC
    Default visibility: the property or item is public.
    UNRECOGNIZED
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EXPORT_VALUE
    Export visibility: expose this item to the outer invoking context.
    static final int
    PACKAGE_VALUE
    Package visibility: items or objects in the same package can access and address this item.
    static final int
    PRIVATE_VALUE
    Private visibility: only usable and addressable by itself, or associated items.
    static final int
    PROTECTED_VALUE
    Protected visibility: children and other associated objects can access or address this item.
    static final int
    PUBLIC_VALUE
    Default visibility: the property or item is public.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Visibility
    forNumber(int value)
     
    static final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptor()
     
    final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptorForType()
     
    final int
    getNumber()
     
    final com.google.protobuf.Descriptors.EnumValueDescriptor
    getValueDescriptor()
     
    static com.google.protobuf.Internal.EnumLiteMap<Visibility>
    internalGetValueMap()
     
    static Visibility
    valueOf(int value)
    Deprecated.
    static Visibility
    valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
    Returns the enum constant of this class with the specified name.
    static Visibility
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Visibility[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PUBLIC

      public static final Visibility PUBLIC
       Default visibility: the property or item is public.
      PUBLIC = 0;

    • PRIVATE

      public static final Visibility PRIVATE
       Private visibility: only usable and addressable by itself, or associated items.
      PRIVATE = 1;

    • PROTECTED

      public static final Visibility PROTECTED
       Protected visibility: children and other associated objects can access or address this item.
      PROTECTED = 2;

    • PACKAGE

      public static final Visibility PACKAGE
       Package visibility: items or objects in the same package can access and address this item.
      PACKAGE = 3;

    • EXPORT

      public static final Visibility EXPORT
       Export visibility: expose this item to the outer invoking context.
      EXPORT = 4;

    • UNRECOGNIZED

      public static final Visibility UNRECOGNIZED

  • Field Details

    • PUBLIC_VALUE

      public static final int PUBLIC_VALUE
       Default visibility: the property or item is public.
      PUBLIC = 0;
      See Also:

    • PRIVATE_VALUE

      public static final int PRIVATE_VALUE
       Private visibility: only usable and addressable by itself, or associated items.
      PRIVATE = 1;
      See Also:

    • PROTECTED_VALUE

      public static final int PROTECTED_VALUE
       Protected visibility: children and other associated objects can access or address this item.
      PROTECTED = 2;
      See Also:

    • PACKAGE_VALUE

      public static final int PACKAGE_VALUE
       Package visibility: items or objects in the same package can access and address this item.
      PACKAGE = 3;
      See Also:

    • EXPORT_VALUE

      public static final int EXPORT_VALUE
       Export visibility: expose this item to the outer invoking context.
      EXPORT = 4;
      See Also:

  • Method Details

    • values

      public static Visibility[] 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 Visibility 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

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static Visibility valueOf(int value)
      Deprecated.
      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:
      value - 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

    • forNumber

      public static Visibility forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<Visibility> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static Visibility valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      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:
      desc - 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