Bookmark.Builder (com.ironsoftware:ironpdf 2023.7.2 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Bookmark.Builder>
    - - com.ironsoftware.ironpdf.internal.proto.Bookmark.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BookmarkOrBuilder, Cloneable

Enclosing class:

Bookmark
```
public static final class Bookmark.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Bookmark.Builder>
implements BookmarkOrBuilder
```
Protobuf type IronPdfEngine.Proto.Bookmark

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Bookmark.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Bookmark`	`build()`
`Bookmark`	`buildPartial()`
`Bookmark.Builder`	`clear()`
`Bookmark.Builder`	`clearDestinationType()` `optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;`
`Bookmark.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Bookmark.Builder`	`clearNextBookmarkText()` `optional string next_bookmark_text = 2;`
`Bookmark.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Bookmark.Builder`	`clearPageIndex()` `int32 page_index = 4;`
`Bookmark.Builder`	`clearParentBookmarkText()` `optional string parent_bookmark_text = 3;`
`Bookmark.Builder`	`clearPreviousBookmarkText()` `optional string previous_bookmark_text = 5;`
`Bookmark.Builder`	`clearText()` `string text = 6;`
`Bookmark.Builder`	`clone()`
`Bookmark`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`BookmarkDestinations`	`getDestinationType()` `optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;`
`BookmarkDestinations.Builder`	`getDestinationTypeBuilder()` `optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;`
`BookmarkDestinationsOrBuilder`	`getDestinationTypeOrBuilder()` `optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;`
`String`	`getNextBookmarkText()` `optional string next_bookmark_text = 2;`
`com.google.protobuf.ByteString`	`getNextBookmarkTextBytes()` `optional string next_bookmark_text = 2;`
`int`	`getPageIndex()` `int32 page_index = 4;`
`String`	`getParentBookmarkText()` `optional string parent_bookmark_text = 3;`
`com.google.protobuf.ByteString`	`getParentBookmarkTextBytes()` `optional string parent_bookmark_text = 3;`
`String`	`getPreviousBookmarkText()` `optional string previous_bookmark_text = 5;`
`com.google.protobuf.ByteString`	`getPreviousBookmarkTextBytes()` `optional string previous_bookmark_text = 5;`
`String`	`getText()` `string text = 6;`
`com.google.protobuf.ByteString`	`getTextBytes()` `string text = 6;`
`boolean`	`hasDestinationType()` `optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;`
`boolean`	`hasNextBookmarkText()` `optional string next_bookmark_text = 2;`
`boolean`	`hasParentBookmarkText()` `optional string parent_bookmark_text = 3;`
`boolean`	`hasPreviousBookmarkText()` `optional string previous_bookmark_text = 5;`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Bookmark.Builder`	`mergeDestinationType(BookmarkDestinations value)` `optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;`
`Bookmark.Builder`	`mergeFrom(Bookmark other)`
`Bookmark.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Bookmark.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Bookmark.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Bookmark.Builder`	`setDestinationType(BookmarkDestinations.Builder builderForValue)` `optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;`
`Bookmark.Builder`	`setDestinationType(BookmarkDestinations value)` `optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;`
`Bookmark.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Bookmark.Builder`	`setNextBookmarkText(String value)` `optional string next_bookmark_text = 2;`
`Bookmark.Builder`	`setNextBookmarkTextBytes(com.google.protobuf.ByteString value)` `optional string next_bookmark_text = 2;`
`Bookmark.Builder`	`setPageIndex(int value)` `int32 page_index = 4;`
`Bookmark.Builder`	`setParentBookmarkText(String value)` `optional string parent_bookmark_text = 3;`
`Bookmark.Builder`	`setParentBookmarkTextBytes(com.google.protobuf.ByteString value)` `optional string parent_bookmark_text = 3;`
`Bookmark.Builder`	`setPreviousBookmarkText(String value)` `optional string previous_bookmark_text = 5;`
`Bookmark.Builder`	`setPreviousBookmarkTextBytes(com.google.protobuf.ByteString value)` `optional string previous_bookmark_text = 5;`
`Bookmark.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Bookmark.Builder`	`setText(String value)` `string text = 6;`
`Bookmark.Builder`	`setTextBytes(com.google.protobuf.ByteString value)` `string text = 6;`
`Bookmark.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- 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<Bookmark.Builder>
  - clear
```
public Bookmark.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<Bookmark.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<Bookmark.Builder>
  - getDefaultInstanceForType
```
public Bookmark getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Bookmark build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Bookmark buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Bookmark.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<Bookmark.Builder>
  - setField
```
public Bookmark.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<Bookmark.Builder>
  - clearField
```
public Bookmark.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<Bookmark.Builder>
  - clearOneof
```
public Bookmark.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<Bookmark.Builder>
  - setRepeatedField
```
public Bookmark.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<Bookmark.Builder>
  - addRepeatedField
```
public Bookmark.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<Bookmark.Builder>
  - mergeFrom
```
public Bookmark.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<Bookmark.Builder>
  - mergeFrom
```
public Bookmark.Builder mergeFrom(Bookmark other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Bookmark.Builder>
  - mergeFrom
```
public Bookmark.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<Bookmark.Builder>
    
    Throws:
    
    IOException
  - hasDestinationType
```
public boolean hasDestinationType()
```
    optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;
    
    Specified by:
    
    hasDestinationType in interface BookmarkOrBuilder
    
    Returns:
    
    Whether the destinationType field is set.
  - getDestinationType
```
public BookmarkDestinations getDestinationType()
```
    optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;
    
    Specified by:
    
    getDestinationType in interface BookmarkOrBuilder
    
    Returns:
    
    The destinationType.
  - setDestinationType
```
public Bookmark.Builder setDestinationType(BookmarkDestinations value)
```
    optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;
  - setDestinationType
```
public Bookmark.Builder setDestinationType(BookmarkDestinations.Builder builderForValue)
```
    optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;
  - mergeDestinationType
```
public Bookmark.Builder mergeDestinationType(BookmarkDestinations value)
```
    optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;
  - clearDestinationType
```
public Bookmark.Builder clearDestinationType()
```
    optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;
  - getDestinationTypeBuilder
```
public BookmarkDestinations.Builder getDestinationTypeBuilder()
```
    optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;
  - getDestinationTypeOrBuilder
```
public BookmarkDestinationsOrBuilder getDestinationTypeOrBuilder()
```
    optional .IronPdfEngine.Proto.BookmarkDestinations destination_type = 1;
    
    Specified by:
    
    getDestinationTypeOrBuilder in interface BookmarkOrBuilder
  - hasNextBookmarkText
```
public boolean hasNextBookmarkText()
```
    optional string next_bookmark_text = 2;
    
    Specified by:
    
    hasNextBookmarkText in interface BookmarkOrBuilder
    
    Returns:
    
    Whether the nextBookmarkText field is set.
  - getNextBookmarkText
```
public String getNextBookmarkText()
```
    optional string next_bookmark_text = 2;
    
    Specified by:
    
    getNextBookmarkText in interface BookmarkOrBuilder
    
    Returns:
    
    The nextBookmarkText.
  - getNextBookmarkTextBytes
```
public com.google.protobuf.ByteString getNextBookmarkTextBytes()
```
    optional string next_bookmark_text = 2;
    
    Specified by:
    
    getNextBookmarkTextBytes in interface BookmarkOrBuilder
    
    Returns:
    
    The bytes for nextBookmarkText.
  - setNextBookmarkText
```
public Bookmark.Builder setNextBookmarkText(String value)
```
    optional string next_bookmark_text = 2;
    
    Parameters:
    
    value - The nextBookmarkText to set.
    
    Returns:
    
    This builder for chaining.
  - clearNextBookmarkText
```
public Bookmark.Builder clearNextBookmarkText()
```
    optional string next_bookmark_text = 2;
    
    Returns:
    
    This builder for chaining.
  - setNextBookmarkTextBytes
```
public Bookmark.Builder setNextBookmarkTextBytes(com.google.protobuf.ByteString value)
```
    optional string next_bookmark_text = 2;
    
    Parameters:
    
    value - The bytes for nextBookmarkText to set.
    
    Returns:
    
    This builder for chaining.
  - hasParentBookmarkText
```
public boolean hasParentBookmarkText()
```
    optional string parent_bookmark_text = 3;
    
    Specified by:
    
    hasParentBookmarkText in interface BookmarkOrBuilder
    
    Returns:
    
    Whether the parentBookmarkText field is set.
  - getParentBookmarkText
```
public String getParentBookmarkText()
```
    optional string parent_bookmark_text = 3;
    
    Specified by:
    
    getParentBookmarkText in interface BookmarkOrBuilder
    
    Returns:
    
    The parentBookmarkText.
  - getParentBookmarkTextBytes
```
public com.google.protobuf.ByteString getParentBookmarkTextBytes()
```
    optional string parent_bookmark_text = 3;
    
    Specified by:
    
    getParentBookmarkTextBytes in interface BookmarkOrBuilder
    
    Returns:
    
    The bytes for parentBookmarkText.
  - setParentBookmarkText
```
public Bookmark.Builder setParentBookmarkText(String value)
```
    optional string parent_bookmark_text = 3;
    
    Parameters:
    
    value - The parentBookmarkText to set.
    
    Returns:
    
    This builder for chaining.
  - clearParentBookmarkText
```
public Bookmark.Builder clearParentBookmarkText()
```
    optional string parent_bookmark_text = 3;
    
    Returns:
    
    This builder for chaining.
  - setParentBookmarkTextBytes
```
public Bookmark.Builder setParentBookmarkTextBytes(com.google.protobuf.ByteString value)
```
    optional string parent_bookmark_text = 3;
    
    Parameters:
    
    value - The bytes for parentBookmarkText to set.
    
    Returns:
    
    This builder for chaining.
  - getPageIndex
```
public int getPageIndex()
```
    int32 page_index = 4;
    
    Specified by:
    
    getPageIndex in interface BookmarkOrBuilder
    
    Returns:
    
    The pageIndex.
  - setPageIndex
```
public Bookmark.Builder setPageIndex(int value)
```
    int32 page_index = 4;
    
    Parameters:
    
    value - The pageIndex to set.
    
    Returns:
    
    This builder for chaining.
  - clearPageIndex
```
public Bookmark.Builder clearPageIndex()
```
    int32 page_index = 4;
    
    Returns:
    
    This builder for chaining.
  - hasPreviousBookmarkText
```
public boolean hasPreviousBookmarkText()
```
    optional string previous_bookmark_text = 5;
    
    Specified by:
    
    hasPreviousBookmarkText in interface BookmarkOrBuilder
    
    Returns:
    
    Whether the previousBookmarkText field is set.
  - getPreviousBookmarkText
```
public String getPreviousBookmarkText()
```
    optional string previous_bookmark_text = 5;
    
    Specified by:
    
    getPreviousBookmarkText in interface BookmarkOrBuilder
    
    Returns:
    
    The previousBookmarkText.
  - getPreviousBookmarkTextBytes
```
public com.google.protobuf.ByteString getPreviousBookmarkTextBytes()
```
    optional string previous_bookmark_text = 5;
    
    Specified by:
    
    getPreviousBookmarkTextBytes in interface BookmarkOrBuilder
    
    Returns:
    
    The bytes for previousBookmarkText.
  - setPreviousBookmarkText
```
public Bookmark.Builder setPreviousBookmarkText(String value)
```
    optional string previous_bookmark_text = 5;
    
    Parameters:
    
    value - The previousBookmarkText to set.
    
    Returns:
    
    This builder for chaining.
  - clearPreviousBookmarkText
```
public Bookmark.Builder clearPreviousBookmarkText()
```
    optional string previous_bookmark_text = 5;
    
    Returns:
    
    This builder for chaining.
  - setPreviousBookmarkTextBytes
```
public Bookmark.Builder setPreviousBookmarkTextBytes(com.google.protobuf.ByteString value)
```
    optional string previous_bookmark_text = 5;
    
    Parameters:
    
    value - The bytes for previousBookmarkText to set.
    
    Returns:
    
    This builder for chaining.
  - getText
```
public String getText()
```
    string text = 6;
    
    Specified by:
    
    getText in interface BookmarkOrBuilder
    
    Returns:
    
    The text.
  - getTextBytes
```
public com.google.protobuf.ByteString getTextBytes()
```
    string text = 6;
    
    Specified by:
    
    getTextBytes in interface BookmarkOrBuilder
    
    Returns:
    
    The bytes for text.
  - setText
```
public Bookmark.Builder setText(String value)
```
    string text = 6;
    
    Parameters:
    
    value - The text to set.
    
    Returns:
    
    This builder for chaining.
  - clearText
```
public Bookmark.Builder clearText()
```
    string text = 6;
    
    Returns:
    
    This builder for chaining.
  - setTextBytes
```
public Bookmark.Builder setTextBytes(com.google.protobuf.ByteString value)
```
    string text = 6;
    
    Parameters:
    
    value - The bytes for text to set.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final Bookmark.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<Bookmark.Builder>
  - mergeUnknownFields
```
public final Bookmark.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<Bookmark.Builder>

Class Bookmark.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasDestinationType

getDestinationType

setDestinationType

setDestinationType

mergeDestinationType

clearDestinationType

getDestinationTypeBuilder

getDestinationTypeOrBuilder

hasNextBookmarkText

getNextBookmarkText

getNextBookmarkTextBytes

setNextBookmarkText

clearNextBookmarkText

setNextBookmarkTextBytes

hasParentBookmarkText

getParentBookmarkText

getParentBookmarkTextBytes

setParentBookmarkText

clearParentBookmarkText

setParentBookmarkTextBytes

getPageIndex

setPageIndex

clearPageIndex

hasPreviousBookmarkText

getPreviousBookmarkText

getPreviousBookmarkTextBytes

setPreviousBookmarkText

clearPreviousBookmarkText

setPreviousBookmarkTextBytes

getText

getTextBytes

setText

clearText

setTextBytes

setUnknownFields

mergeUnknownFields