com.amazonaws.services.textract.model

Class SplitDocument

java.lang.Object

com.amazonaws.services.textract.model.SplitDocument

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SplitDocument
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains information about the pages of a document, defined by logical boundary.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SplitDocument()

Method Summary

Modifier and Type	Method and Description
SplitDocument	clone()
boolean	equals(Object obj)
Integer	getIndex() The index for a given document in a DocumentGroup of a specific Type.
List<Integer>	getPages() An array of page numbers for a for a given document, ordered by logical boundary.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setIndex(Integer index) The index for a given document in a DocumentGroup of a specific Type.
void	setPages(Collection<Integer> pages) An array of page numbers for a for a given document, ordered by logical boundary.
String	toString() Returns a string representation of this object.
SplitDocument	withIndex(Integer index) The index for a given document in a DocumentGroup of a specific Type.
SplitDocument	withPages(Collection<Integer> pages) An array of page numbers for a for a given document, ordered by logical boundary.
SplitDocument	withPages(Integer... pages) An array of page numbers for a for a given document, ordered by logical boundary.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SplitDocument

public SplitDocument()

Method Detail

setIndex

public void setIndex(Integer index)

The index for a given document in a DocumentGroup of a specific Type.

Parameters:

index - The index for a given document in a DocumentGroup of a specific Type.

getIndex

public Integer getIndex()

The index for a given document in a DocumentGroup of a specific Type.

Returns:

The index for a given document in a DocumentGroup of a specific Type.

withIndex

public SplitDocument withIndex(Integer index)

The index for a given document in a DocumentGroup of a specific Type.

Parameters:

index - The index for a given document in a DocumentGroup of a specific Type.

Returns:

Returns a reference to this object so that method calls can be chained together.

getPages

public List<Integer> getPages()

An array of page numbers for a for a given document, ordered by logical boundary.

Returns:

An array of page numbers for a for a given document, ordered by logical boundary.

setPages

public void setPages(Collection<Integer> pages)

An array of page numbers for a for a given document, ordered by logical boundary.

Parameters:

pages - An array of page numbers for a for a given document, ordered by logical boundary.

withPages

public SplitDocument withPages(Integer... pages)

An array of page numbers for a for a given document, ordered by logical boundary.

NOTE: This method appends the values to the existing list (if any). Use setPages(java.util.Collection) or withPages(java.util.Collection) if you want to override the existing values.

Parameters:

pages - An array of page numbers for a for a given document, ordered by logical boundary.

Returns:

Returns a reference to this object so that method calls can be chained together.

withPages

public SplitDocument withPages(Collection<Integer> pages)

An array of page numbers for a for a given document, ordered by logical boundary.

Parameters:

pages - An array of page numbers for a for a given document, ordered by logical boundary.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SplitDocument clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.