Package io.opencensus.tags

Enum TaggingState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TaggingState>
    public enum TaggingState
extends java.lang.Enum<TaggingState>
    State of the TagsComponent.
    Since:
    0.8

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DISABLED
      State that disables tagging.
      ENABLED
      State that fully enables tagging.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private TaggingState()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static TaggingState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TaggingState[] 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

      • ENABLED

        public static final TaggingState ENABLED
        State that fully enables tagging.

        The TagsComponent can add tags to TagContexts, propagate TagContexts in the current context, and serialize TagContexts.

        Since:
        0.8

      • DISABLED

        public static final TaggingState DISABLED
        State that disables tagging.

        The TagsComponent may not add tags to TagContexts, propagate TagContexts in the current context, or serialize TagContexts.

        Since:
        0.8

    • Constructor Detail

      • TaggingState

        private TaggingState()

    • Method Detail

      • values

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

      • valueOf

        public static TaggingState 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