Package io.cucumber.messages

Class Messages.Pickle

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Messages.PickleOrBuilder, Serializable
    Enclosing class:
    Messages
    public static final class Messages.Pickle
extends com.google.protobuf.GeneratedMessageV3
implements Messages.PickleOrBuilder
    
 A `Pickle` represents a template for a `TestCase`. It is typically derived
 from another format, such as [GherkinDocument](#io.cucumber.messages.GherkinDocument).
 In the future a `Pickle` may be derived from other formats such as Markdown or
 Excel files.
 By making `Pickle` the main data structure Cucumber uses for execution, the
 implementation of Cucumber itself becomes simpler, as it doesn't have to deal
 with the complex structure of a [GherkinDocument](#io.cucumber.messages.GherkinDocument).
 Each `PickleStep` of a `Pickle` is matched with a `StepDefinition` to create a `TestCase`
    Protobuf type io.cucumber.messages.Pickle
    See Also:
    Serialized Form

    • Method Detail

      • 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

      • getId

        public String getId()
        
 A unique id for the pickle. This is a [SHA1](https://en.wikipedia.org/wiki/SHA-1) hash
 from the source data and the `locations` of the pickle.
 This ID will change if source the file is modified.
        string id = 1;
        Specified by:
        getId in interface Messages.PickleOrBuilder

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
        
 A unique id for the pickle. This is a [SHA1](https://en.wikipedia.org/wiki/SHA-1) hash
 from the source data and the `locations` of the pickle.
 This ID will change if source the file is modified.
        string id = 1;
        Specified by:
        getIdBytes in interface Messages.PickleOrBuilder

      • getUriBytes

        public com.google.protobuf.ByteString getUriBytes()
         The uri of the source file
        string uri = 2;
        Specified by:
        getUriBytes in interface Messages.PickleOrBuilder

      • getStepsCount

        public int getStepsCount()
         One or more steps
        repeated .io.cucumber.messages.Pickle.PickleStep steps = 5;
        Specified by:
        getStepsCount in interface Messages.PickleOrBuilder

      • getTagsList

        public List<Messages.Pickle.PickleTag> getTagsList()
        
 One or more tags. If this pickle is constructed from a Gherkin document,
 It includes inherited tags from the `Feature` as well.
        repeated .io.cucumber.messages.Pickle.PickleTag tags = 6;
        Specified by:
        getTagsList in interface Messages.PickleOrBuilder

      • getTagsCount

        public int getTagsCount()
        
 One or more tags. If this pickle is constructed from a Gherkin document,
 It includes inherited tags from the `Feature` as well.
        repeated .io.cucumber.messages.Pickle.PickleTag tags = 6;
        Specified by:
        getTagsCount in interface Messages.PickleOrBuilder

      • getTags

        public Messages.Pickle.PickleTag getTags​(int index)
        
 One or more tags. If this pickle is constructed from a Gherkin document,
 It includes inherited tags from the `Feature` as well.
        repeated .io.cucumber.messages.Pickle.PickleTag tags = 6;
        Specified by:
        getTags in interface Messages.PickleOrBuilder

      • getAstNodeIdsList

        public com.google.protobuf.ProtocolStringList getAstNodeIdsList()
        
 Points to the AST node locations of the pickle. The last one represents the unique
 id of the pickle. A pickle constructed from `Examples` will have the first
 id originating from the `Scenario` AST node, and the second from the `TableRow` AST node.
        repeated string ast_node_ids = 7;
        Specified by:
        getAstNodeIdsList in interface Messages.PickleOrBuilder

      • getAstNodeIdsCount

        public int getAstNodeIdsCount()
        
 Points to the AST node locations of the pickle. The last one represents the unique
 id of the pickle. A pickle constructed from `Examples` will have the first
 id originating from the `Scenario` AST node, and the second from the `TableRow` AST node.
        repeated string ast_node_ids = 7;
        Specified by:
        getAstNodeIdsCount in interface Messages.PickleOrBuilder

      • getAstNodeIds

        public String getAstNodeIds​(int index)
        
 Points to the AST node locations of the pickle. The last one represents the unique
 id of the pickle. A pickle constructed from `Examples` will have the first
 id originating from the `Scenario` AST node, and the second from the `TableRow` AST node.
        repeated string ast_node_ids = 7;
        Specified by:
        getAstNodeIds in interface Messages.PickleOrBuilder

      • getAstNodeIdsBytes

        public com.google.protobuf.ByteString getAstNodeIdsBytes​(int index)
        
 Points to the AST node locations of the pickle. The last one represents the unique
 id of the pickle. A pickle constructed from `Examples` will have the first
 id originating from the `Scenario` AST node, and the second from the `TableRow` AST node.
        repeated string ast_node_ids = 7;
        Specified by:
        getAstNodeIdsBytes in interface Messages.PickleOrBuilder

      • 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 Messages.Pickle parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static Messages.Pickle parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Messages.Pickle> 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 Messages.Pickle getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder