Package io.cucumber.messages

Class Messages.Pickle.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Messages.PickleOrBuilder, Cloneable
    Enclosing class:
    Messages.Pickle
    public static final class Messages.Pickle.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>
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

    • Method Detail

      • 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.Builder<Messages.Pickle.Builder>

      • clear

        public Messages.Pickle.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Messages.Pickle.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>

      • setField

        public Messages.Pickle.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>

      • clearField

        public Messages.Pickle.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>

      • clearOneof

        public Messages.Pickle.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>

      • setRepeatedField

        public Messages.Pickle.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>

      • addRepeatedField

        public Messages.Pickle.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>

      • mergeFrom

        public Messages.Pickle.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Messages.Pickle.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>

      • mergeFrom

        public Messages.Pickle.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Messages.Pickle.Builder>
        Throws:
        IOException

      • 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

      • setId

        public Messages.Pickle.Builder setId​(String value)
        
 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;

      • clearId

        public Messages.Pickle.Builder clearId()
        
 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;

      • setIdBytes

        public Messages.Pickle.Builder setIdBytes​(com.google.protobuf.ByteString value)
        
 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;

      • getUriBytes

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

      • setUriBytes

        public Messages.Pickle.Builder setUriBytes​(com.google.protobuf.ByteString value)
         The uri of the source file
        string uri = 2;

      • setNameBytes

        public Messages.Pickle.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The name of the pickle
        string name = 3;

      • setLanguageBytes

        public Messages.Pickle.Builder setLanguageBytes​(com.google.protobuf.ByteString value)
         The language of the pickle
        string language = 4;

      • getStepsCount

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

      • clearSteps

        public Messages.Pickle.Builder clearSteps()
         One or more steps
        repeated .io.cucumber.messages.Pickle.PickleStep steps = 5;

      • removeSteps

        public Messages.Pickle.Builder removeSteps​(int index)
         One or more steps
        repeated .io.cucumber.messages.Pickle.PickleStep steps = 5;

      • getStepsBuilder

        public Messages.Pickle.PickleStep.Builder getStepsBuilder​(int index)
         One or more steps
        repeated .io.cucumber.messages.Pickle.PickleStep steps = 5;

      • addStepsBuilder

        public Messages.Pickle.PickleStep.Builder addStepsBuilder​(int index)
         One or more steps
        repeated .io.cucumber.messages.Pickle.PickleStep steps = 5;

      • 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

      • setTags

        public Messages.Pickle.Builder setTags​(int index,
                                       Messages.Pickle.PickleTag value)
        
 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;

      • setTags

        public Messages.Pickle.Builder setTags​(int index,
                                       Messages.Pickle.PickleTag.Builder builderForValue)
        
 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;

      • addTags

        public Messages.Pickle.Builder addTags​(Messages.Pickle.PickleTag value)
        
 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;

      • addTags

        public Messages.Pickle.Builder addTags​(int index,
                                       Messages.Pickle.PickleTag value)
        
 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;

      • addTags

        public Messages.Pickle.Builder addTags​(Messages.Pickle.PickleTag.Builder builderForValue)
        
 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;

      • addTags

        public Messages.Pickle.Builder addTags​(int index,
                                       Messages.Pickle.PickleTag.Builder builderForValue)
        
 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;

      • addAllTags

        public Messages.Pickle.Builder addAllTags​(Iterable<? extends Messages.Pickle.PickleTag> values)
        
 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;

      • clearTags

        public Messages.Pickle.Builder clearTags()
        
 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;

      • removeTags

        public Messages.Pickle.Builder removeTags​(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;

      • getTagsBuilder

        public Messages.Pickle.PickleTag.Builder getTagsBuilder​(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;

      • addTagsBuilder

        public Messages.Pickle.PickleTag.Builder addTagsBuilder()
        
 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;

      • addTagsBuilder

        public Messages.Pickle.PickleTag.Builder addTagsBuilder​(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;

      • getTagsBuilderList

        public List<Messages.Pickle.PickleTag.Builder> getTagsBuilderList()
        
 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;

      • 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

      • setAstNodeIds

        public Messages.Pickle.Builder setAstNodeIds​(int index,
                                             String value)
        
 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;

      • addAstNodeIds

        public Messages.Pickle.Builder addAstNodeIds​(String value)
        
 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;

      • addAllAstNodeIds

        public Messages.Pickle.Builder addAllAstNodeIds​(Iterable<String> values)
        
 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;

      • clearAstNodeIds

        public Messages.Pickle.Builder clearAstNodeIds()
        
 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;

      • addAstNodeIdsBytes

        public Messages.Pickle.Builder addAstNodeIdsBytes​(com.google.protobuf.ByteString value)
        
 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;

      • setUnknownFields

        public final Messages.Pickle.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>

      • mergeUnknownFields

        public final Messages.Pickle.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Messages.Pickle.Builder>