Page.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>
    - - com.google.api.Page.Builder

All Implemented Interfaces:: PageOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: Page

public static final class Page.Builder
extends GeneratedMessageV3.Builder<Page.Builder>
implements PageOrBuilder

 Represents a documentation page. A page can contain subpages to represent
 nested documentation set structure.

Protobuf type google.api.Page

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Page.Builder`	`addAllSubpages(java.lang.Iterable<? extends Page> values)` Subpages of this page.
`Page.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`Page.Builder`	`addSubpages(int index, Page.Builder builderForValue)` Subpages of this page.
`Page.Builder`	`addSubpages(int index, Page value)` Subpages of this page.
`Page.Builder`	`addSubpages(Page.Builder builderForValue)` Subpages of this page.
`Page.Builder`	`addSubpages(Page value)` Subpages of this page.
`Page.Builder`	`addSubpagesBuilder()` Subpages of this page.
`Page.Builder`	`addSubpagesBuilder(int index)` Subpages of this page.
`Page`	`build()`
`Page`	`buildPartial()`
`Page.Builder`	`clear()`
`Page.Builder`	`clearContent()` The Markdown content of the page.
`Page.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`Page.Builder`	`clearName()` The name of the page.
`Page.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`Page.Builder`	`clearSubpages()` Subpages of this page.
`Page.Builder`	`clone()`
`java.lang.String`	`getContent()` The Markdown content of the page.
`ByteString`	`getContentBytes()` The Markdown content of the page.
`Page`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getName()` The name of the page.
`ByteString`	`getNameBytes()` The name of the page.
`Page`	`getSubpages(int index)` Subpages of this page.
`Page.Builder`	`getSubpagesBuilder(int index)` Subpages of this page.
`java.util.List<Page.Builder>`	`getSubpagesBuilderList()` Subpages of this page.
`int`	`getSubpagesCount()` Subpages of this page.
`java.util.List<Page>`	`getSubpagesList()` Subpages of this page.
`PageOrBuilder`	`getSubpagesOrBuilder(int index)` Subpages of this page.
`java.util.List<? extends PageOrBuilder>`	`getSubpagesOrBuilderList()` Subpages of this page.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Page.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`Page.Builder`	`mergeFrom(Message other)`
`Page.Builder`	`mergeFrom(Page other)`
`Page.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`Page.Builder`	`removeSubpages(int index)` Subpages of this page.
`Page.Builder`	`setContent(java.lang.String value)` The Markdown content of the page.
`Page.Builder`	`setContentBytes(ByteString value)` The Markdown content of the page.
`Page.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`Page.Builder`	`setName(java.lang.String value)` The name of the page.
`Page.Builder`	`setNameBytes(ByteString value)` The name of the page.
`Page.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`Page.Builder`	`setSubpages(int index, Page.Builder builderForValue)` Subpages of this page.
`Page.Builder`	`setSubpages(int index, Page value)` Subpages of this page.
`Page.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

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

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

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, 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.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Page.Builder>

clear
```
public Page.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<Page.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<Page.Builder>

getDefaultInstanceForType
```
public Page getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public Page build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public Page buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public Page.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<Page.Builder>

setField

public Page.Builder setField(Descriptors.FieldDescriptor field,
                             java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<Page.Builder>

clearField
```
public Page.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<Page.Builder>

clearOneof
```
public Page.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<Page.Builder>

setRepeatedField

public Page.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                     int index,
                                     java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<Page.Builder>

addRepeatedField
```
public Page.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                     java.lang.Object value)
```
Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<Page.Builder>

mergeFrom
```
public Page.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Page.Builder>

mergeFrom

public Page.Builder mergeFrom(Page other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<Page.Builder>

mergeFrom

public Page.Builder mergeFrom(CodedInputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<Page.Builder>
Throws:: java.io.IOException

getName

public java.lang.String getName()

 The name of the page. It will be used as an identity of the page to
 generate URI of the page, text of the link to this page in navigation,
 etc. The full page name (start from the root page name to this page
 concatenated with `.`) can be used as reference to the page in your
 documentation. For example:
 <pre><code>pages:
 - name: Tutorial
   content: &#40;== include tutorial.md ==&#41;
   subpages:
   - name: Java
     content: &#40;== include tutorial_java.md ==&#41;
 </code></pre>
 You can reference `Java` page using Markdown reference link syntax:
 `[Java][Tutorial.Java]`.

string name = 1;

Specified by:: getName in interface PageOrBuilder

getNameBytes

public ByteString getNameBytes()

 The name of the page. It will be used as an identity of the page to
 generate URI of the page, text of the link to this page in navigation,
 etc. The full page name (start from the root page name to this page
 concatenated with `.`) can be used as reference to the page in your
 documentation. For example:
 <pre><code>pages:
 - name: Tutorial
   content: &#40;== include tutorial.md ==&#41;
   subpages:
   - name: Java
     content: &#40;== include tutorial_java.md ==&#41;
 </code></pre>
 You can reference `Java` page using Markdown reference link syntax:
 `[Java][Tutorial.Java]`.

string name = 1;

Specified by:: getNameBytes in interface PageOrBuilder

setName

public Page.Builder setName(java.lang.String value)

 The name of the page. It will be used as an identity of the page to
 generate URI of the page, text of the link to this page in navigation,
 etc. The full page name (start from the root page name to this page
 concatenated with `.`) can be used as reference to the page in your
 documentation. For example:
 <pre><code>pages:
 - name: Tutorial
   content: &#40;== include tutorial.md ==&#41;
   subpages:
   - name: Java
     content: &#40;== include tutorial_java.md ==&#41;
 </code></pre>
 You can reference `Java` page using Markdown reference link syntax:
 `[Java][Tutorial.Java]`.

string name = 1;

clearName

public Page.Builder clearName()

 The name of the page. It will be used as an identity of the page to
 generate URI of the page, text of the link to this page in navigation,
 etc. The full page name (start from the root page name to this page
 concatenated with `.`) can be used as reference to the page in your
 documentation. For example:
 <pre><code>pages:
 - name: Tutorial
   content: &#40;== include tutorial.md ==&#41;
   subpages:
   - name: Java
     content: &#40;== include tutorial_java.md ==&#41;
 </code></pre>
 You can reference `Java` page using Markdown reference link syntax:
 `[Java][Tutorial.Java]`.

string name = 1;

setNameBytes

public Page.Builder setNameBytes(ByteString value)

 The name of the page. It will be used as an identity of the page to
 generate URI of the page, text of the link to this page in navigation,
 etc. The full page name (start from the root page name to this page
 concatenated with `.`) can be used as reference to the page in your
 documentation. For example:
 <pre><code>pages:
 - name: Tutorial
   content: &#40;== include tutorial.md ==&#41;
   subpages:
   - name: Java
     content: &#40;== include tutorial_java.md ==&#41;
 </code></pre>
 You can reference `Java` page using Markdown reference link syntax:
 `[Java][Tutorial.Java]`.

string name = 1;

getContent

public java.lang.String getContent()

 The Markdown content of the page. You can use <code>&#40;== include {path}
 ==&#41;</code> to include content from a Markdown file.

string content = 2;

Specified by:: getContent in interface PageOrBuilder

getContentBytes

public ByteString getContentBytes()

 The Markdown content of the page. You can use <code>&#40;== include {path}
 ==&#41;</code> to include content from a Markdown file.

string content = 2;

Specified by:: getContentBytes in interface PageOrBuilder

setContent

public Page.Builder setContent(java.lang.String value)

 The Markdown content of the page. You can use <code>&#40;== include {path}
 ==&#41;</code> to include content from a Markdown file.

string content = 2;

clearContent

public Page.Builder clearContent()

 The Markdown content of the page. You can use <code>&#40;== include {path}
 ==&#41;</code> to include content from a Markdown file.

string content = 2;

setContentBytes

public Page.Builder setContentBytes(ByteString value)

 The Markdown content of the page. You can use <code>&#40;== include {path}
 ==&#41;</code> to include content from a Markdown file.

string content = 2;