Operator (PDFBox reactor 2.0.2 API)

java.lang.Object
+
- org.apache.pdfbox.contentstream.operator.Operator
+

+
+
+
```
public final class Operator
+extends Object
```
+
An Operator in a PDF content stream.
+
Author:
+
Ben Litchfield
+

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`byte[]`	`getImageData()` + This is the special case for the ID operator where there are just random + bytes inlined the stream. +
`COSDictionary`	`getImageParameters()` + This will get the image parameters, this is only valid for BI operators. +
`String`	`getName()` + This will get the name of the operator. +
`static Operator`	`getOperator(String operator)` + This is used to create/cache operators in the system. +
`void`	`setImageData(byte[] imageDataArray)` + This will set the image data, this is only used for the ID operator. +
`void`	`setImageParameters(COSDictionary params)` + This will set the image parameters, this is only valid for BI operators. +
`String`	`toString()` + This will print a string rep of this class. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Method Detail
  + + + +
  - +
    getOperator
    +
```
public static Operator getOperator(String operator)
```
    +
    This is used to create/cache operators in the system.
    +
    Parameters:
    operator - The operator for the system.
    +
    Returns:
    The operator that matches the operator keyword.
    +
  + + + +
  - +
    getName
    +
```
public String getName()
```
    +
    This will get the name of the operator.
    +
    Returns:
    The string representation of the operation.
    +
  + + + +
  - +
    toString
    +
```
public String toString()
```
    +
    This will print a string rep of this class.
    +
    +
    Overrides:
    +
    toString in class Object
    +
    Returns:
    A string rep of this class.
    +
  + + + +
  - +
    getImageData
    +
```
public byte[] getImageData()
```
    +
    This is the special case for the ID operator where there are just random + bytes inlined the stream.
    +
    Returns:
    Value of property imageData.
    +
  + + + +
  - +
    setImageData
    +
```
public void setImageData(byte[] imageDataArray)
```
    +
    This will set the image data, this is only used for the ID operator.
    +
    Parameters:
    imageDataArray - New value of property imageData.
    +
  + + + +
  - +
    getImageParameters
    +
```
public COSDictionary getImageParameters()
```
    +
    This will get the image parameters, this is only valid for BI operators.
    +
    Returns:
    The image parameters.
    +
  + + + +
  - +
    setImageParameters
    +
```
public void setImageParameters(COSDictionary params)
```
    +
    This will set the image parameters, this is only valid for BI operators.
    +
    Parameters:
    params - The image parameters.
    +
  +
+

java.lang.Object
+
- org.apache.pdfbox.contentstream.operator.OperatorProcessor
+

+
+
Direct Known Subclasses:
+
BeginMarkedContentSequence, BeginMarkedContentSequenceWithProperties, BeginText, Concatenate, DrawObject, DrawObject, EndMarkedContentSequence, EndText, GraphicsOperatorProcessor, MoveText, MoveTextSetLeading, NextLine, Restore, Save, SetCharSpacing, SetColor, SetFlatness, SetFontAndSize, SetGraphicsStateParameters, SetLineCapStyle, SetLineDashPattern, SetLineJoinStyle, SetLineMiterLimit, SetLineWidth, SetMatrix, SetNonStrokingColorSpace, SetRenderingIntent, SetStrokingColorSpace, SetTextHorizontalScaling, SetTextLeading, SetTextRenderingMode, SetTextRise, SetWordSpacing, ShowText, ShowTextAdjusted, ShowTextLine, ShowTextLineAndSpace, StubOperator
+
+
+
+
```
public abstract class OperatorProcessor
+extends Object
```
+
Processes a PDF operator.
+
Author:
+
Laurent Huault
+

+ +

+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
protected PDFStreamEngine context +
The processing context.
+
+

Fields
Modifier and Type	Field and Description
`protected PDFStreamEngine`	`context` + The processing context. +

+ +

+ + +
Constructor Summary
+ + + + + + + + + + +
Constructors
Modifier Constructor and Description
protected OperatorProcessor() +
Creates a new OperatorProcessor.
+
+

Constructors
Modifier	Constructor and Description
`protected`	`OperatorProcessor()` + Creates a new OperatorProcessor. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`boolean`	`checkArrayTypesClass(List<COSBase> operands, + Class clazz)` + Check whether all operands list elements are an instance of a specific class. +
`protected PDFStreamEngine`	`getContext()` + Returns the processing context. +
`abstract String`	`getName()` + Returns the name of this operator, e.g. +
`abstract void`	`process(Operator operator, + List<COSBase> operands)` + Process the operator. +
`void`	`setContext(PDFStreamEngine context)` + Sets the processing context. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Field Detail
  + + + +
  - +
    context
    +
```
protected PDFStreamEngine context
```
    +
    The processing context.
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    OperatorProcessor
    +
```
protected OperatorProcessor()
```
    +
    Creates a new OperatorProcessor.
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getContext
    +
```
protected final PDFStreamEngine getContext()
```
    +
    Returns the processing context.
    +
    Returns:
    the processing context
    +
  + + + +
  - +
    setContext
    +
```
public void setContext(PDFStreamEngine context)
```
    +
    Sets the processing context.
    +
    Parameters:
    context - the processing context.
    +
  + + + +
  - +
    process
    +
```
public abstract void process(Operator operator,
+           List<COSBase> operands)
+                      throws IOException
```
    +
    Process the operator.
    +
    Parameters:
    operator - the operator to process
    operands - the operands to use when processing
    +
    Throws:
    +
    IOException - if the operator cannot be processed
    +
  + + + +
  - +
    getName
    +
```
public abstract String getName()
```
    +
    Returns the name of this operator, e.g. "BI".
    +
  + + + +
  - +
    checkArrayTypesClass
    +
```
public boolean checkArrayTypesClass(List<COSBase> operands,
+                           Class clazz)
```
    +
    Check whether all operands list elements are an instance of a specific class.
    +
    Parameters:
    operands - The operands list.
    clazz - The expected class.
    +
    Returns:
    the boolean
    +
  +
+

Packages that use MissingOperandException
Package	Description
org.apache.pdfbox.contentstream.operator.state
org.apache.pdfbox.contentstream.operator.text

Packages that use MissingOperandException

Package

Description

org.apache.pdfbox.contentstream.operator.state

org.apache.pdfbox.contentstream.operator.text

Methods in org.apache.pdfbox.contentstream.operator.state that throw MissingOperandException
Modifier and Type	Method and Description
`void`	SetMatrix.`process(Operator operator, + List<COSBase> arguments)`
`void`	SetLineDashPattern.`process(Operator operator, + List<COSBase> arguments)`

Methods in org.apache.pdfbox.contentstream.operator.state that throw MissingOperandException

Modifier and Type

Method and Description

void

SetMatrix.

process(Operator operator,
+       List<COSBase> arguments)

void

SetLineDashPattern.

process(Operator operator,
+       List<COSBase> arguments)

Methods in org.apache.pdfbox.contentstream.operator.text that throw MissingOperandException
Modifier and Type	Method and Description
`void`	MoveText.`process(Operator operator, + List<COSBase> arguments)`

Methods in org.apache.pdfbox.contentstream.operator.text that throw MissingOperandException

Modifier and Type

Method and Description

void

MoveText.

process(Operator operator,
+       List<COSBase> arguments)

Class Operator

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getOperator

getName

toString

getImageData

setImageData

getImageParameters

setImageParameters

Class OperatorProcessor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

context

Constructor Detail

OperatorProcessor

Method Detail

getContext

setContext

process

getName

checkArrayTypesClass

Uses of Class
org.apache.pdfbox.contentstream.operator.DrawObject

Uses of Class
org.apache.pdfbox.contentstream.operator.MissingOperandException

Uses of MissingOperandException in org.apache.pdfbox.contentstream.operator.state

Uses of MissingOperandException in org.apache.pdfbox.contentstream.operator.text

Class Operator

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getOperator

getName

toString

getImageData

setImageData

getImageParameters

setImageParameters

Class OperatorProcessor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

context

Constructor Detail

OperatorProcessor

Method Detail

getContext

setContext

process

getName

checkArrayTypesClass

Uses of Classorg.apache.pdfbox.contentstream.operator.DrawObject

Uses of Classorg.apache.pdfbox.contentstream.operator.MissingOperandException

Uses of MissingOperandException in org.apache.pdfbox.contentstream.operator.state

Uses of MissingOperandException in org.apache.pdfbox.contentstream.operator.text

Uses of Class
org.apache.pdfbox.contentstream.operator.DrawObject

Uses of Class
org.apache.pdfbox.contentstream.operator.MissingOperandException