pspdfkit/com.pspdfkit.document/PdfValue

PdfValue

This represents a value stored inside a PDF document stream. The PDF has a few different data types of values that are reasonably interchangeable. The type can be retrieved with getType and can be one of PdfValueType.

When creating a new value, the type will be automatically set depending on the constructor parameter.

Constructors

PdfValue

constructor(longValue: Long)

Creates a new PDF value of INTEGER type.

constructor(doubleValue: Double)

Creates a new PDF value of DOUBLE type.

constructor(booleanValue: Boolean)

Creates a new PDF value of BOOLEAN type.

constructor(@NonNull stringValue: String)

Creates a new PDF value of STRING type.

constructor(@NonNull listValue: List<PdfValue>)

Creates a new PDF value of ARRAY type.

constructor(@NonNull mapValue: Map<String, PdfValue>)

Creates a new PDF value of DICTIONARY type.

constructor()

Creates a new PDF value of NULLOBJ type.

Types

PdfValueType

enum PdfValueType

Type of a value stored in the PDF document stream.

Properties

type

@NonNull

@get:NonNull

val type: PdfValue.PdfValueType

Functions

getArray

open fun getArray(): List<PdfValue>

Gets the stored List of PdfValues or null if the value isn't an array.

getBoolean

open fun getBoolean(): Boolean

Gets the stored Boolean value or false if the value isn't a boolean.

getDictionary

open fun getDictionary(): Map<String, PdfValue>

Gets the stored Map of String and PdfValues, or null if the value isn't a dictionary.

getDouble

open fun getDouble(): Double

Gets the stored Double value or 0.0 if the value isn't a double.

getLong

open fun getLong(): Long

Gets the stored Long value or 0 if the value isn't an integer.

getString

open fun getString(): String

Gets the stored String value or null if the value isn't a string.

toString

open fun toString(): String