Package org.yamcs.protobuf

Class TemplateVariable

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.TemplateVariable
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, TemplateVariableOrBuilder
public final class TemplateVariable extends com.google.protobuf.GeneratedMessageV3 implements TemplateVariableOrBuilder
Protobuf type yamcs.protobuf.instances.TemplateVariable
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TemplateVariable.Builder
    Protobuf type yamcs.protobuf.instances.TemplateVariable

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CHOICES_FIELD_NUMBER
     
    static final int
    HELP_FIELD_NUMBER
     
    static final int
    INITIAL_FIELD_NUMBER
     
    static final int
    LABEL_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<TemplateVariable>
    PARSER
    Deprecated.
    static final int
    REQUIRED_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getChoices(int index)
    List of valid choices
    com.google.protobuf.ByteString
    getChoicesBytes(int index)
    List of valid choices
    int
    getChoicesCount()
    List of valid choices
    com.google.protobuf.ProtocolStringList
    getChoicesList()
    List of valid choices
    static TemplateVariable
    getDefaultInstance()
     
    TemplateVariable
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getHelp()
    Verbose user guidance (HTML)
    com.google.protobuf.ByteString
    getHelpBytes()
    Verbose user guidance (HTML)
    String
    getInitial()
    Initial value for use in UI forms
    com.google.protobuf.ByteString
    getInitialBytes()
    Initial value for use in UI forms
    String
    getLabel()
    Verbose name for use in UI forms
    com.google.protobuf.ByteString
    getLabelBytes()
    Verbose name for use in UI forms
    String
    getName()
    Variable name.
    com.google.protobuf.ByteString
    getNameBytes()
    Variable name.
    com.google.protobuf.Parser<TemplateVariable>
    getParserForType()
     
    boolean
    getRequired()
    Whether this variable is required input
    int
    getSerializedSize()
     
    String
    getType()
    Type of variable (Java class extending org.yamcs.templating.Variable)
    com.google.protobuf.ByteString
    getTypeBytes()
    Type of variable (Java class extending org.yamcs.templating.Variable)
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    int
    hashCode()
     
    boolean
    hasHelp()
    Verbose user guidance (HTML)
    boolean
    hasInitial()
    Initial value for use in UI forms
    boolean
    hasLabel()
    Verbose name for use in UI forms
    boolean
    hasName()
    Variable name.
    boolean
    hasRequired()
    Whether this variable is required input
    boolean
    hasType()
    Type of variable (Java class extending org.yamcs.templating.Variable)
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static TemplateVariable.Builder
    newBuilder()
     
    static TemplateVariable.Builder
    newBuilder(TemplateVariable prototype)
     
    TemplateVariable.Builder
    newBuilderForType()
     
    protected TemplateVariable.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static TemplateVariable
    parseDelimitedFrom(InputStream input)
     
    static TemplateVariable
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TemplateVariable
    parseFrom(byte[] data)
     
    static TemplateVariable
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TemplateVariable
    parseFrom(com.google.protobuf.ByteString data)
     
    static TemplateVariable
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TemplateVariable
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TemplateVariable
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TemplateVariable
    parseFrom(InputStream input)
     
    static TemplateVariable
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TemplateVariable
    parseFrom(ByteBuffer data)
     
    static TemplateVariable
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TemplateVariable>
    parser()
     
    TemplateVariable.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasName

      public boolean hasName()
       Variable name.
      optional string name = 1;
      Specified by:
      hasName in interface TemplateVariableOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       Variable name.
      optional string name = 1;
      Specified by:
      getName in interface TemplateVariableOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Variable name.
      optional string name = 1;
      Specified by:
      getNameBytes in interface TemplateVariableOrBuilder
      Returns:
      The bytes for name.

    • hasLabel

      public boolean hasLabel()
       Verbose name for use in UI forms
      optional string label = 6;
      Specified by:
      hasLabel in interface TemplateVariableOrBuilder
      Returns:
      Whether the label field is set.

    • getLabel

      public String getLabel()
       Verbose name for use in UI forms
      optional string label = 6;
      Specified by:
      getLabel in interface TemplateVariableOrBuilder
      Returns:
      The label.

    • getLabelBytes

      public com.google.protobuf.ByteString getLabelBytes()
       Verbose name for use in UI forms
      optional string label = 6;
      Specified by:
      getLabelBytes in interface TemplateVariableOrBuilder
      Returns:
      The bytes for label.

    • hasType

      public boolean hasType()
       Type of variable (Java class extending org.yamcs.templating.Variable)
      optional string type = 4;
      Specified by:
      hasType in interface TemplateVariableOrBuilder
      Returns:
      Whether the type field is set.

    • getType

      public String getType()
       Type of variable (Java class extending org.yamcs.templating.Variable)
      optional string type = 4;
      Specified by:
      getType in interface TemplateVariableOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.ByteString getTypeBytes()
       Type of variable (Java class extending org.yamcs.templating.Variable)
      optional string type = 4;
      Specified by:
      getTypeBytes in interface TemplateVariableOrBuilder
      Returns:
      The bytes for type.

    • hasHelp

      public boolean hasHelp()
       Verbose user guidance (HTML)
      optional string help = 2;
      Specified by:
      hasHelp in interface TemplateVariableOrBuilder
      Returns:
      Whether the help field is set.

    • getHelp

      public String getHelp()
       Verbose user guidance (HTML)
      optional string help = 2;
      Specified by:
      getHelp in interface TemplateVariableOrBuilder
      Returns:
      The help.

    • getHelpBytes

      public com.google.protobuf.ByteString getHelpBytes()
       Verbose user guidance (HTML)
      optional string help = 2;
      Specified by:
      getHelpBytes in interface TemplateVariableOrBuilder
      Returns:
      The bytes for help.

    • hasRequired

      public boolean hasRequired()
       Whether this variable is required input
      optional bool required = 3;
      Specified by:
      hasRequired in interface TemplateVariableOrBuilder
      Returns:
      Whether the required field is set.

    • getRequired

      public boolean getRequired()
       Whether this variable is required input
      optional bool required = 3;
      Specified by:
      getRequired in interface TemplateVariableOrBuilder
      Returns:
      The required.

    • getChoicesList

      public com.google.protobuf.ProtocolStringList getChoicesList()
       List of valid choices
      repeated string choices = 5;
      Specified by:
      getChoicesList in interface TemplateVariableOrBuilder
      Returns:
      A list containing the choices.

    • getChoicesCount

      public int getChoicesCount()
       List of valid choices
      repeated string choices = 5;
      Specified by:
      getChoicesCount in interface TemplateVariableOrBuilder
      Returns:
      The count of choices.

    • getChoices

      public String getChoices(int index)
       List of valid choices
      repeated string choices = 5;
      Specified by:
      getChoices in interface TemplateVariableOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The choices at the given index.

    • getChoicesBytes

      public com.google.protobuf.ByteString getChoicesBytes(int index)
       List of valid choices
      repeated string choices = 5;
      Specified by:
      getChoicesBytes in interface TemplateVariableOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the choices at the given index.

    • hasInitial

      public boolean hasInitial()
       Initial value for use in UI forms
      optional string initial = 7;
      Specified by:
      hasInitial in interface TemplateVariableOrBuilder
      Returns:
      Whether the initial field is set.

    • getInitial

      public String getInitial()
       Initial value for use in UI forms
      optional string initial = 7;
      Specified by:
      getInitial in interface TemplateVariableOrBuilder
      Returns:
      The initial.

    • getInitialBytes

      public com.google.protobuf.ByteString getInitialBytes()
       Initial value for use in UI forms
      optional string initial = 7;
      Specified by:
      getInitialBytes in interface TemplateVariableOrBuilder
      Returns:
      The bytes for initial.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TemplateVariable parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TemplateVariable parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TemplateVariable parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TemplateVariable parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TemplateVariable parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TemplateVariable parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TemplateVariable parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TemplateVariable parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TemplateVariable parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TemplateVariable parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TemplateVariable parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TemplateVariable parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TemplateVariable.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TemplateVariable.Builder newBuilder()

    • newBuilder

      public static TemplateVariable.Builder newBuilder(TemplateVariable prototype)

    • toBuilder

      public TemplateVariable.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TemplateVariable.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static TemplateVariable getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TemplateVariable> parser()

    • getParserForType

      public com.google.protobuf.Parser<TemplateVariable> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public TemplateVariable getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder