Package com.ironsoftware.ironpdf.internal.proto

Class AddBackgroundForegroundRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.ironsoftware.ironpdf.internal.proto.AddBackgroundForegroundRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AddBackgroundForegroundRequestOrBuilder, Serializable

public final class AddBackgroundForegroundRequest
extends com.google.protobuf.GeneratedMessageV3
implements AddBackgroundForegroundRequestOrBuilder

Protobuf type IronPdfEngine.Proto.AddBackgroundForegroundRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AddBackgroundForegroundRequest.Builder	Protobuf type IronPdfEngine.Proto.AddBackgroundForegroundRequest
static enum	AddBackgroundForegroundRequest.LayerCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BACKGROUND_PDF_FIELD_NUMBER
static final int	BASE_PDF_FIELD_NUMBER
static final int	BASE_PDF_PAGES_FIELD_NUMBER
static final int	FOREGROUND_PDF_FIELD_NUMBER
static final int	LAYER_PDF_PAGE_INDEX_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
PdfDocument	getBackgroundPdf()	.IronPdfEngine.Proto.PdfDocument background_pdf = 2;
PdfDocumentOrBuilder	getBackgroundPdfOrBuilder()	.IronPdfEngine.Proto.PdfDocument background_pdf = 2;
PdfDocument	getBasePdf()	.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;
static AddBackgroundForegroundRequest	getDefaultInstance()
AddBackgroundForegroundRequest	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
PdfDocument	getForegroundPdf()	.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;
com.google.protobuf.Parser<AddBackgroundForegroundRequest>	getParserForType()
int	getSerializedSize()
final com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBackgroundPdf()	.IronPdfEngine.Proto.PdfDocument background_pdf = 2;
boolean	hasBasePdf()	.IronPdfEngine.Proto.PdfDocument base_pdf = 1;
boolean	hasForegroundPdf()	.IronPdfEngine.Proto.PdfDocument foreground_pdf = 3;
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static AddBackgroundForegroundRequest.Builder	newBuilder()
static AddBackgroundForegroundRequest.Builder	newBuilder(AddBackgroundForegroundRequest prototype)
AddBackgroundForegroundRequest.Builder	newBuilderForType()
protected AddBackgroundForegroundRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AddBackgroundForegroundRequest	parseDelimitedFrom(InputStream input)
static AddBackgroundForegroundRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddBackgroundForegroundRequest	parseFrom(byte[] data)
static AddBackgroundForegroundRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddBackgroundForegroundRequest	parseFrom(com.google.protobuf.ByteString data)
static AddBackgroundForegroundRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddBackgroundForegroundRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static AddBackgroundForegroundRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddBackgroundForegroundRequest	parseFrom(InputStream input)
static AddBackgroundForegroundRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddBackgroundForegroundRequest	parseFrom(ByteBuffer data)
static AddBackgroundForegroundRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AddBackgroundForegroundRequest>	parser()
AddBackgroundForegroundRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Details

BASE_PDF_FIELD_NUMBER

public static final int BASE_PDF_FIELD_NUMBER

See Also:

• Constant Field Values

BACKGROUND_PDF_FIELD_NUMBER

public static final int BACKGROUND_PDF_FIELD_NUMBER

See Also:

• Constant Field Values

FOREGROUND_PDF_FIELD_NUMBER

public static final int FOREGROUND_PDF_FIELD_NUMBER

See Also:

• Constant Field Values

LAYER_PDF_PAGE_INDEX_FIELD_NUMBER

public static final int LAYER_PDF_PAGE_INDEX_FIELD_NUMBER

See Also:

• Constant Field Values

BASE_PDF_PAGES_FIELD_NUMBER

public static final int BASE_PDF_PAGES_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getLayerCase

public AddBackgroundForegroundRequest.LayerCase getLayerCase()

Specified by:

getLayerCase in interface AddBackgroundForegroundRequestOrBuilder

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.

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.

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.

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.

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.

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 AddBackgroundForegroundRequest parseFrom(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddBackgroundForegroundRequest parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddBackgroundForegroundRequest parseFrom(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddBackgroundForegroundRequest parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddBackgroundForegroundRequest parseFrom(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddBackgroundForegroundRequest parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddBackgroundForegroundRequest parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static AddBackgroundForegroundRequest parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static AddBackgroundForegroundRequest parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static AddBackgroundForegroundRequest parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseFrom

public static AddBackgroundForegroundRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static AddBackgroundForegroundRequest parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

newBuilderForType

public AddBackgroundForegroundRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AddBackgroundForegroundRequest.Builder newBuilder()

newBuilder

public static AddBackgroundForegroundRequest.Builder newBuilder(AddBackgroundForegroundRequest prototype)

toBuilder

public AddBackgroundForegroundRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AddBackgroundForegroundRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AddBackgroundForegroundRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<AddBackgroundForegroundRequest> 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 AddBackgroundForegroundRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder