com.ironsoftware.ironpdf.internal.proto

Class AddBackgroundForegroundRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<AddBackgroundForegroundRequest.Builder>

com.ironsoftware.ironpdf.internal.proto.AddBackgroundForegroundRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

AddBackgroundForegroundRequest

public static final class AddBackgroundForegroundRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AddBackgroundForegroundRequest.Builder>
implements AddBackgroundForegroundRequestOrBuilder

Protobuf type IronPdfEngine.Proto.AddBackgroundForegroundRequest

Method Summary

Modifier and Type	Method and Description
AddBackgroundForegroundRequest.Builder	addAllBasePdfPages(Iterable<? extends Integer> values) repeated int32 base_pdf_pages = 5;
AddBackgroundForegroundRequest.Builder	addBasePdfPages(int value) repeated int32 base_pdf_pages = 5;
AddBackgroundForegroundRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AddBackgroundForegroundRequest	build()
AddBackgroundForegroundRequest	buildPartial()
AddBackgroundForegroundRequest.Builder	clear()
AddBackgroundForegroundRequest.Builder	clearBackgroundPdf() .IronPdfEngine.Proto.PdfDocument background_pdf = 2;
AddBackgroundForegroundRequest.Builder	clearBasePdf() .IronPdfEngine.Proto.PdfDocument base_pdf = 1;
AddBackgroundForegroundRequest.Builder	clearBasePdfPages() repeated int32 base_pdf_pages = 5;
AddBackgroundForegroundRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AddBackgroundForegroundRequest.Builder	clearForegroundPdf() .IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;
AddBackgroundForegroundRequest.Builder	clearLayer()
AddBackgroundForegroundRequest.Builder	clearLayerPdfPageIndex() int32 layer_pdf_page_index = 4;
AddBackgroundForegroundRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AddBackgroundForegroundRequest.Builder	clone()
PdfDocument	getBackgroundPdf() .IronPdfEngine.Proto.PdfDocument background_pdf = 2;
PdfDocument.Builder	getBackgroundPdfBuilder() .IronPdfEngine.Proto.PdfDocument background_pdf = 2;
PdfDocumentOrBuilder	getBackgroundPdfOrBuilder() .IronPdfEngine.Proto.PdfDocument background_pdf = 2;
PdfDocument	getBasePdf() .IronPdfEngine.Proto.PdfDocument base_pdf = 1;
PdfDocument.Builder	getBasePdfBuilder() .IronPdfEngine.Proto.PdfDocument base_pdf = 1;
PdfDocumentOrBuilder	getBasePdfOrBuilder() .IronPdfEngine.Proto.PdfDocument base_pdf = 1;
int	getBasePdfPages(int index) repeated int32 base_pdf_pages = 5;
int	getBasePdfPagesCount() repeated int32 base_pdf_pages = 5;
List<Integer>	getBasePdfPagesList() repeated int32 base_pdf_pages = 5;
AddBackgroundForegroundRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
PdfDocument	getForegroundPdf() .IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;
PdfDocument.Builder	getForegroundPdfBuilder() .IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;
PdfDocumentOrBuilder	getForegroundPdfOrBuilder() .IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;
AddBackgroundForegroundRequest.LayerCase	getLayerCase()
int	getLayerPdfPageIndex() int32 layer_pdf_page_index = 4;
boolean	hasBackgroundPdf() .IronPdfEngine.Proto.PdfDocument background_pdf = 2;
boolean	hasBasePdf() .IronPdfEngine.Proto.PdfDocument base_pdf = 1;
boolean	hasForegroundPdf() .IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
AddBackgroundForegroundRequest.Builder	mergeBackgroundPdf(PdfDocument value) .IronPdfEngine.Proto.PdfDocument background_pdf = 2;
AddBackgroundForegroundRequest.Builder	mergeBasePdf(PdfDocument value) .IronPdfEngine.Proto.PdfDocument base_pdf = 1;
AddBackgroundForegroundRequest.Builder	mergeForegroundPdf(PdfDocument value) .IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;
AddBackgroundForegroundRequest.Builder	mergeFrom(AddBackgroundForegroundRequest other)
AddBackgroundForegroundRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AddBackgroundForegroundRequest.Builder	mergeFrom(com.google.protobuf.Message other)
AddBackgroundForegroundRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AddBackgroundForegroundRequest.Builder	setBackgroundPdf(PdfDocument.Builder builderForValue) .IronPdfEngine.Proto.PdfDocument background_pdf = 2;
AddBackgroundForegroundRequest.Builder	setBackgroundPdf(PdfDocument value) .IronPdfEngine.Proto.PdfDocument background_pdf = 2;
AddBackgroundForegroundRequest.Builder	setBasePdf(PdfDocument.Builder builderForValue) .IronPdfEngine.Proto.PdfDocument base_pdf = 1;
AddBackgroundForegroundRequest.Builder	setBasePdf(PdfDocument value) .IronPdfEngine.Proto.PdfDocument base_pdf = 1;
AddBackgroundForegroundRequest.Builder	setBasePdfPages(int index, int value) repeated int32 base_pdf_pages = 5;
AddBackgroundForegroundRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AddBackgroundForegroundRequest.Builder	setForegroundPdf(PdfDocument.Builder builderForValue) .IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;
AddBackgroundForegroundRequest.Builder	setForegroundPdf(PdfDocument value) .IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;
AddBackgroundForegroundRequest.Builder	setLayerPdfPageIndex(int value) int32 layer_pdf_page_index = 4;
AddBackgroundForegroundRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

clear

public AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

getDefaultInstanceForType

public AddBackgroundForegroundRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public AddBackgroundForegroundRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public AddBackgroundForegroundRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

setField

public AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

clearField

public AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

clearOneof

public AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

setRepeatedField

public AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

addRepeatedField

public AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

mergeFrom

public AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

mergeFrom

public AddBackgroundForegroundRequest.Builder mergeFrom(AddBackgroundForegroundRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AddBackgroundForegroundRequest.Builder>

mergeFrom

public AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

Throws:

IOException

getLayerCase

public AddBackgroundForegroundRequest.LayerCase getLayerCase()

Specified by:

getLayerCase in interface AddBackgroundForegroundRequestOrBuilder

clearLayer

public AddBackgroundForegroundRequest.Builder clearLayer()

hasBasePdf

public boolean hasBasePdf()

.IronPdfEngine.Proto.PdfDocument base_pdf = 1;

Specified by:

hasBasePdf in interface AddBackgroundForegroundRequestOrBuilder

Returns:

Whether the basePdf field is set.

getBasePdf

public PdfDocument getBasePdf()

.IronPdfEngine.Proto.PdfDocument base_pdf = 1;

Specified by:

getBasePdf in interface AddBackgroundForegroundRequestOrBuilder

Returns:

The basePdf.

setBasePdf

public AddBackgroundForegroundRequest.Builder setBasePdf(PdfDocument value)

.IronPdfEngine.Proto.PdfDocument base_pdf = 1;

setBasePdf

public AddBackgroundForegroundRequest.Builder setBasePdf(PdfDocument.Builder builderForValue)

.IronPdfEngine.Proto.PdfDocument base_pdf = 1;

mergeBasePdf

public AddBackgroundForegroundRequest.Builder mergeBasePdf(PdfDocument value)

.IronPdfEngine.Proto.PdfDocument base_pdf = 1;

clearBasePdf

public AddBackgroundForegroundRequest.Builder clearBasePdf()

.IronPdfEngine.Proto.PdfDocument base_pdf = 1;

getBasePdfBuilder

public PdfDocument.Builder getBasePdfBuilder()

.IronPdfEngine.Proto.PdfDocument base_pdf = 1;

getBasePdfOrBuilder

public PdfDocumentOrBuilder getBasePdfOrBuilder()

.IronPdfEngine.Proto.PdfDocument base_pdf = 1;

Specified by:

getBasePdfOrBuilder in interface AddBackgroundForegroundRequestOrBuilder

hasBackgroundPdf

public boolean hasBackgroundPdf()

.IronPdfEngine.Proto.PdfDocument background_pdf = 2;

Specified by:

hasBackgroundPdf in interface AddBackgroundForegroundRequestOrBuilder

Returns:

Whether the backgroundPdf field is set.

getBackgroundPdf

public PdfDocument getBackgroundPdf()

.IronPdfEngine.Proto.PdfDocument background_pdf = 2;

Specified by:

getBackgroundPdf in interface AddBackgroundForegroundRequestOrBuilder

Returns:

The backgroundPdf.

setBackgroundPdf

public AddBackgroundForegroundRequest.Builder setBackgroundPdf(PdfDocument value)

.IronPdfEngine.Proto.PdfDocument background_pdf = 2;

setBackgroundPdf

public AddBackgroundForegroundRequest.Builder setBackgroundPdf(PdfDocument.Builder builderForValue)

.IronPdfEngine.Proto.PdfDocument background_pdf = 2;

mergeBackgroundPdf

public AddBackgroundForegroundRequest.Builder mergeBackgroundPdf(PdfDocument value)

.IronPdfEngine.Proto.PdfDocument background_pdf = 2;

clearBackgroundPdf

public AddBackgroundForegroundRequest.Builder clearBackgroundPdf()

.IronPdfEngine.Proto.PdfDocument background_pdf = 2;

getBackgroundPdfBuilder

public PdfDocument.Builder getBackgroundPdfBuilder()

.IronPdfEngine.Proto.PdfDocument background_pdf = 2;

getBackgroundPdfOrBuilder

public PdfDocumentOrBuilder getBackgroundPdfOrBuilder()

.IronPdfEngine.Proto.PdfDocument background_pdf = 2;

Specified by:

getBackgroundPdfOrBuilder in interface AddBackgroundForegroundRequestOrBuilder

hasForegroundPdf

public boolean hasForegroundPdf()

.IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;

Specified by:

hasForegroundPdf in interface AddBackgroundForegroundRequestOrBuilder

Returns:

Whether the foregroundPdf field is set.

getForegroundPdf

public PdfDocument getForegroundPdf()

.IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;

Specified by:

getForegroundPdf in interface AddBackgroundForegroundRequestOrBuilder

Returns:

The foregroundPdf.

setForegroundPdf

public AddBackgroundForegroundRequest.Builder setForegroundPdf(PdfDocument value)

.IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;

setForegroundPdf

public AddBackgroundForegroundRequest.Builder setForegroundPdf(PdfDocument.Builder builderForValue)

.IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;

mergeForegroundPdf

public AddBackgroundForegroundRequest.Builder mergeForegroundPdf(PdfDocument value)

.IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;

clearForegroundPdf

public AddBackgroundForegroundRequest.Builder clearForegroundPdf()

.IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;

getForegroundPdfBuilder

public PdfDocument.Builder getForegroundPdfBuilder()

.IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;

getForegroundPdfOrBuilder

public PdfDocumentOrBuilder getForegroundPdfOrBuilder()

.IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;

Specified by:

getForegroundPdfOrBuilder in interface AddBackgroundForegroundRequestOrBuilder

getLayerPdfPageIndex

public int getLayerPdfPageIndex()

int32 layer_pdf_page_index = 4;

Specified by:

getLayerPdfPageIndex in interface AddBackgroundForegroundRequestOrBuilder

Returns:

The layerPdfPageIndex.

setLayerPdfPageIndex

public AddBackgroundForegroundRequest.Builder setLayerPdfPageIndex(int value)

int32 layer_pdf_page_index = 4;

Parameters:

value - The layerPdfPageIndex to set.

Returns:

This builder for chaining.

clearLayerPdfPageIndex

public AddBackgroundForegroundRequest.Builder clearLayerPdfPageIndex()

int32 layer_pdf_page_index = 4;

Returns:

This builder for chaining.

getBasePdfPagesList

public List<Integer> getBasePdfPagesList()

repeated int32 base_pdf_pages = 5;

Specified by:

getBasePdfPagesList in interface AddBackgroundForegroundRequestOrBuilder

Returns:

A list containing the basePdfPages.

getBasePdfPagesCount

public int getBasePdfPagesCount()

repeated int32 base_pdf_pages = 5;

Specified by:

getBasePdfPagesCount in interface AddBackgroundForegroundRequestOrBuilder

Returns:

The count of basePdfPages.

getBasePdfPages

public int getBasePdfPages(int index)

repeated int32 base_pdf_pages = 5;

Specified by:

getBasePdfPages in interface AddBackgroundForegroundRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The basePdfPages at the given index.

setBasePdfPages

public AddBackgroundForegroundRequest.Builder setBasePdfPages(int index,
                                                              int value)

repeated int32 base_pdf_pages = 5;

Parameters:

index - The index to set the value at.

value - The basePdfPages to set.

Returns:

This builder for chaining.

addBasePdfPages

public AddBackgroundForegroundRequest.Builder addBasePdfPages(int value)

repeated int32 base_pdf_pages = 5;

Parameters:

value - The basePdfPages to add.

Returns:

This builder for chaining.

addAllBasePdfPages

public AddBackgroundForegroundRequest.Builder addAllBasePdfPages(Iterable<? extends Integer> values)

repeated int32 base_pdf_pages = 5;

Parameters:

values - The basePdfPages to add.

Returns:

This builder for chaining.

clearBasePdfPages

public AddBackgroundForegroundRequest.Builder clearBasePdfPages()

repeated int32 base_pdf_pages = 5;

Returns:

This builder for chaining.

setUnknownFields

public final AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>

mergeUnknownFields

public final AddBackgroundForegroundRequest.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<AddBackgroundForegroundRequest.Builder>