COSName (Apache PDFBox 1.4.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.pdfbox.cos
Class COSName

java.lang.Object
  org.apache.pdfbox.cos.COSBase
      org.apache.pdfbox.cos.COSName

All Implemented Interfaces:: Comparable<COSName>, COSObjectable

public final class COSName
extends COSBase
implements Comparable<COSName>
extends COSBase
implements Comparable<COSName>

This class represents a PDF named object.

Version:: $Revision: 1.42 $
Author:: Ben Litchfield

Field Summary
`static COSName`	`A` A common COSName value.
`static COSName`	`AA` A common COSName value.
`static COSName`	`ACRO_FORM` A common COSName value.
`static COSName`	`ACTUAL_TEXT` "ActualText"
`static COSName`	`AIS` A common COSName value.
`static COSName`	`ALT` "Alt"
`static COSName`	`ALTERNATE` "Alt"
`static COSName`	`ANNOTS` A common COSName value.
`static COSName`	`AP` "AP"
`static COSName`	`ART_BOX` A common COSName value.
`static COSName`	`ARTIFACT` "Artifact"
`static COSName`	`ASCII_HEX_DECODE` A common COSName value.
`static COSName`	`ASCII_HEX_DECODE_ABBREVIATION` A common COSName value.
`static COSName`	`ASCII85_DECODE` A common COSName value.
`static COSName`	`ASCII85_DECODE_ABBREVIATION` A common COSName value.
`static COSName`	`ATTACHED` "Attached"
`static COSName`	`AUTHOR` A common COSName value.
`static COSName`	`B` A common COSName value.
`static COSName`	`BASE_ENCODING` A common COSName value.
`static COSName`	`BASE_FONT` A common COSName value.
`static COSName`	`BASE_STATE` the COSName for "BaseState".
`static COSName`	`BBOX` A common COSName value.
`static COSName`	`BITS_PER_COMPONENT` A common COSName value.
`static COSName`	`BITS_PER_SAMPLE` A common COSName value.
`static COSName`	`BLACK_IS_1` A common COSName value.
`static COSName`	`BLACK_POINT` A common COSName value.
`static COSName`	`BLEED_BOX` A common COSName value.
`static COSName`	`BOUNDS` A common COSName value.
`static COSName`	`BPC` A common COSName value.
`static COSName`	`C` "C"
`static COSName`	`C0` A common COSName value.
`static COSName`	`C1` A common COSName value.
`static COSName`	`CA` A common COSName value.
`static COSName`	`CA_NS` A common COSName value.
`static COSName`	`CALGRAY` A common COSName value.
`static COSName`	`CALRGB` A common COSName value.
`static COSName`	`CATALOG` A common COSName value.
`static COSName`	`CCITTFAX_DECODE` A common COSName value.
`static COSName`	`CCITTFAX_DECODE_ABBREVIATION` A common COSName value.
`static COSName`	`CF` A common COSName value.
`static COSName`	`CFM` A common COSName value.
`static COSName`	`CHAR_PROCS` A common COSName value.
`static COSName`	`CHAR_SET` A common COSName value.
`static COSName`	`CID_FONT_TYPE0` A common COSName value.
`static COSName`	`CID_FONT_TYPE2` A common COSName value.
`static COSName`	`CIDSYSTEMINFO` A common COSName value.
`static COSName`	`COLORANTS` A common COSName value.
`static COSName`	`COLORSPACE` A common COSName value.
`static COSName`	`COLUMNS` A common COSName value.
`static COSName`	`CONTENTS` A common COSName value.
`static COSName`	`COUNT` A common COSName value.
`static COSName`	`CREATION_DATE` A common COSName value.
`static COSName`	`CREATOR` A common COSName value.
`static COSName`	`CROP_BOX` A common COSName value.
`static COSName`	`CRYPT` The Crypt filter.
`static COSName`	`CS` A common COSName value.
`static COSName`	`D` "D"
`static COSName`	`DCT_DECODE` A common COSName value.
`static COSName`	`DCT_DECODE_ABBREVIATION` A common COSName value.
`static COSName`	`DECODE` A common COSName value.
`static COSName`	`DECODE_PARMS` "DecodeParms"
`static COSName`	`DESCENDANT_FONTS` A common COSName value.
`static COSName`	`DEST` A common COSName value.
`static COSName`	`DESTS` "Dests"
`static COSName`	`DEVICECMYK` A common COSName value.
`static COSName`	`DEVICEGRAY` A common COSName value.
`static COSName`	`DEVICEN` A common COSName value.
`static COSName`	`DEVICERGB` A common COSName value.
`static COSName`	`DIFFERENCES` A common COSName value.
`static COSName`	`DL` "DL"
`static COSName`	`DOMAIN` A common COSName value.
`static COSName`	`DP` "DP"
`static COSName`	`DV` A common COSName value.
`static COSName`	`DW` A common COSName value.
`static COSName`	`E` "E"
`static COSName`	`EMBEDDED_FILES` "EmbeddedFiles"
`static COSName`	`ENCODE` A common COSName value.
`static COSName`	`ENCODING` A common COSName value.
`static COSName`	`ENCODING_90MS_RKSJ_H` A common COSName value.
`static COSName`	`ENCODING_90MS_RKSJ_V` A common COSName value.
`static COSName`	`ENCODING_ETEN_B5_H` A common COSName value.
`static COSName`	`ENCODING_ETEN_B5_V` A common COSName value.
`static COSName`	`ENCRYPT` "Encrypt"
`static COSName`	`ENCRYPT_META_DATA` "EncryptMetaData"
`static COSName`	`EXT_G_STATE` "ExtGState"
`static COSName`	`EXTENDS` "Extends"
`static COSName`	`F` "F"
`static COSName`	`F_DECODE_PARMS` "FDecodeParms"
`static COSName`	`F_FILTER` "FFilter"
`static COSName`	`FIELDS` A common COSName value.
`static COSName`	`FILTER` A common COSName value.
`static COSName`	`FIRST_CHAR` A common COSName value.
`static COSName`	`FL` A common COSName value.
`static COSName`	`FLATE_DECODE` A common COSName value.
`static COSName`	`FLATE_DECODE_ABBREVIATION` A common COSName value.
`static COSName`	`FONT` A common COSName value.
`static COSName`	`FONT_BBOX` A common COSName value.
`static COSName`	`FONT_DESC` A common COSName value.
`static COSName`	`FONT_FAMILY` A common COSName value.
`static COSName`	`FONT_FILE` A common COSName value.
`static COSName`	`FONT_FILE2` A common COSName value.
`static COSName`	`FONT_FILE3` A common COSName value.
`static COSName`	`FONT_MATRIX` A common COSName value.
`static COSName`	`FONT_NAME` A common COSName value.
`static COSName`	`FONT_STRETCH` A common COSName value.
`static COSName`	`FORMTYPE` A common COSName value.
`static COSName`	`FRM` A common COSName value.
`static COSName`	`FUNCTION_TYPE` A common COSName value.
`static COSName`	`FUNCTIONS` A common COSName value.
`static COSName`	`GAMMA` A common COSName value.
`static COSName`	`H` A common COSName value.
`static COSName`	`HEIGHT` A common COSName value.
`static COSName`	`ICCBASED` A common COSName value.
`static COSName`	`ID` "ID"
`static COSName`	`ID_TREE` "IDTree"
`static COSName`	`IDENTITY` A common COSName value.
`static COSName`	`IDENTITY_H` A common COSName value.
`static COSName`	`IMAGE` A common COSName value.
`static COSName`	`IMAGE_MASK` A common COSName value.
`static COSName`	`INDEX` "Index"
`static COSName`	`INDEXED` A common COSName value.
`static COSName`	`INFO` A common COSName value.
`static COSName`	`JAVA_SCRIPT` "JavaScript"
`static COSName`	`JBIG2_DECODE` A common COSName value.
`static COSName`	`JPX_DECODE` A common COSName value.
`static COSName`	`K` "K"
`static COSName`	`KEYWORDS` A common COSName value.
`static COSName`	`KIDS` "Kids"
`static COSName`	`LAB` A common COSName value.
`static COSName`	`LANG` "Lang"
`static COSName`	`LAST_CHAR` A common COSName value.
`static COSName`	`LC` A common COSName value.
`static COSName`	`LENGTH` A common COSName value.
`static COSName`	`LENGTH1` A common COSName value.
`static COSName`	`LIMITS` "Limits"
`static COSName`	`LJ` A common COSName value.
`static COSName`	`LW` A common COSName value.
`static COSName`	`LZW_DECODE` A common COSName value.
`static COSName`	`LZW_DECODE_ABBREVIATION` A common COSName value.
`static COSName`	`MAC_ROMAN_ENCODING` A common COSName value.
`static COSName`	`MARK_INFO` "MarkInfo"
`static COSName`	`MASK` A common COSName value.
`static COSName`	`MATRIX` A common COSName value.
`static COSName`	`MCID` "MCID"
`static COSName`	`MEDIA_BOX` A common COSName value.
`static COSName`	`METADATA` A common COSName value.
`static COSName`	`ML` A common COSName value.
`static COSName`	`MM_TYPE1` A common COSName value.
`static COSName`	`MOD_DATE` A common COSName value.
`static COSName`	`N` A common COSName value.
`static COSName`	`NAME` A common COSName value.
`static byte[]`	`NAME_ESCAPE` The escape character for a name.
`static byte[]`	`NAME_PREFIX` The prefix to a PDF name.
`static COSName`	`NAMES` "Names"
`static COSName`	`NUMS` "Nums"
`static COSName`	`O` "O"
`static COSName`	`OBJ` "Obj"
`static COSName`	`OC` the COSName for the content group tag.
`static COSName`	`OCG` the COSName for an optional content group.
`static COSName`	`OCGS` the COSName for the optional content group list.
`static COSName`	`OCPROPERTIES` the COSName for the optional content properties.
`static COSName`	`OFF` the COSName for the "OFF" value.
`static COSName`	`ON` the COSName for the "ON" value.
`static COSName`	`OP` A common COSName value.
`static COSName`	`OP_NS` A common COSName value.
`static COSName`	`OPEN_ACTION` "OpenAction"
`static COSName`	`OPM` A common COSName value.
`static COSName`	`ORDER` A common COSName value.
`static COSName`	`ORDERING` A common COSName value.
`static COSName`	`OUTLINES` "Outlines"
`static COSName`	`P` A common COSName value.
`static COSName`	`PAGE` A common COSName value.
`static COSName`	`PAGE_LABELS` "PageLabels"
`static COSName`	`PAGE_LAYOUT` "PageLayout"
`static COSName`	`PAGE_MODE` "PageMode"
`static COSName`	`PAGES` A common COSName value.
`static COSName`	`PARENT` A common COSName value.
`static COSName`	`PARENT_TREE_NEXT_KEY` "ParentTreeNextKey"
`static COSName`	`PATTERN` A common COSName value.
`static COSName`	`PDF_DOC_ENCODING` A common COSName value.
`static COSName`	`PG` "Pg"
`static COSName`	`PREDICTOR` A common COSName value.
`static COSName`	`PREV` A common COSName value.
`static COSName`	`PROC_SET` The COSName value for "ProcSet".
`static COSName`	`PRODUCER` A common COSName value.
`static COSName`	`PROPERTIES` The COSName value for "Properties".
`static COSName`	`R` A common COSName value.
`static COSName`	`RANGE` A common COSName value.
`static COSName`	`RECIPIENTS` A common COSName value.
`static COSName`	`REGISTRY` A common COSName value.
`static COSName`	`RESOURCES` A common COSName value.
`static COSName`	`RI` "RoleMap"
`static COSName`	`ROLE_MAP` A common COSName value.
`static COSName`	`ROOT` A common COSName value.
`static COSName`	`ROTATE` A common COSName value.
`static COSName`	`ROWS` A common COSName value.
`static COSName`	`RUN_LENGTH_DECODE` A common COSName value.
`static COSName`	`RUN_LENGTH_DECODE_ABBREVIATION` A common COSName value.
`static COSName`	`S` "S"
`static COSName`	`SA` A common COSName value.
`static COSName`	`SEPARATION` A common COSName value.
`static COSName`	`SHADING` "Shading"
`static COSName`	`SIZE` "Size"
`static COSName`	`SM` A common COSName value.
`static COSName`	`SMASK` A common COSName value.
`static COSName`	`STANDARD_ENCODING` A common COSName value.
`static COSName`	`STD_CF` A common COSName value.
`static COSName`	`STM_F` A common COSName value.
`static COSName`	`STR_F` A common COSName value.
`static COSName`	`STRUCT_TREE_ROOT` "StructTreeRoot"
`static COSName`	`SUB_FILTER` A common COSName value.
`static COSName`	`SUBJECT` A common COSName value.
`static COSName`	`SUBTYPE` A common COSName value.
`static COSName`	`SUPPLEMENT` A common COSName value.
`static COSName`	`T` "T"
`static COSName`	`THREADS` "Threads"
`static COSName`	`TITLE` A common COSName value.
`static COSName`	`TK` A common COSName value.
`static COSName`	`TO_UNICODE` A common COSName value.
`static COSName`	`TRAPPED` A common COSName value.
`static COSName`	`TRIM_BOX` A common COSName value.
`static COSName`	`TRUE_TYPE` A common COSName value.
`static COSName`	`TYPE` A common COSName value.
`static COSName`	`TYPE0` A common COSName value.
`static COSName`	`TYPE1` A common COSName value.
`static COSName`	`TYPE3` A common COSName value.
`static COSName`	`U` A common COSName value.
`static COSName`	`UNCHANGED` the COSName for the "Unchanged" value.
`static COSName`	`URI` "URI"
`static COSName`	`V` A common COSName value.
`static COSName`	`VERSION` A common COSName value.
`static COSName`	`VIEWER_PREFERENCES` "ViewerPreferences"
`static COSName`	`W` A common COSName value.
`static COSName`	`WHITE_POINT` A common COSName value.
`static COSName`	`WIDTH` A common COSName value.
`static COSName`	`WIDTHS` A common COSName value.
`static COSName`	`WIN_ANSI_ENCODING` A common COSName value.
`static COSName`	`XOBJECT` "XObject"

Method Summary
`Object`	`accept(ICOSVisitor visitor)` visitor pattern double dispatch method.
`static void`	`clearResources()` Not usually needed except if resources need to be reclaimed in a ong running process.
`int`	`compareTo(COSName other)`
`boolean`	`equals(Object o)`
`String`	`getName()` This will get the name of this COSName object.
`static COSName`	`getPDFName(String aName)` This will get a COSName object with that name.
`int`	`hashCode()`
`String`	`toString()`
`void`	`writePDF(OutputStream output)` This will output this string as a PDF object.

Methods inherited from class org.apache.pdfbox.cos.COSBase
`getCOSObject, getFilterManager`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

A

public static final COSName A

A common COSName value.

AA

public static final COSName AA

A common COSName value.

ACRO_FORM

public static final COSName ACRO_FORM

A common COSName value.

ACTUAL_TEXT

public static final COSName ACTUAL_TEXT

"ActualText"

AIS

public static final COSName AIS

A common COSName value.

ALT

public static final COSName ALT

"Alt"

ALTERNATE

public static final COSName ALTERNATE

"Alt"

ANNOTS

public static final COSName ANNOTS

A common COSName value.

ARTIFACT

public static final COSName ARTIFACT

"Artifact"

ART_BOX

public static final COSName ART_BOX

A common COSName value.

ASCII85_DECODE

public static final COSName ASCII85_DECODE

A common COSName value.

ASCII85_DECODE_ABBREVIATION

public static final COSName ASCII85_DECODE_ABBREVIATION

A common COSName value.

ATTACHED

public static final COSName ATTACHED

"Attached"

ASCII_HEX_DECODE

public static final COSName ASCII_HEX_DECODE

A common COSName value.

ASCII_HEX_DECODE_ABBREVIATION

public static final COSName ASCII_HEX_DECODE_ABBREVIATION

A common COSName value.

AP

public static final COSName AP

"AP"

AUTHOR

public static final COSName AUTHOR

A common COSName value.

B

public static final COSName B

A common COSName value.

BASE_ENCODING

public static final COSName BASE_ENCODING

A common COSName value.

BASE_FONT

public static final COSName BASE_FONT

A common COSName value.

BASE_STATE

public static final COSName BASE_STATE

the COSName for "BaseState".

BBOX

public static final COSName BBOX

A common COSName value.

BLACK_IS_1

public static final COSName BLACK_IS_1

A common COSName value.

BLACK_POINT

public static final COSName BLACK_POINT

A common COSName value.

BLEED_BOX

public static final COSName BLEED_BOX

A common COSName value.

BITS_PER_COMPONENT

public static final COSName BITS_PER_COMPONENT

A common COSName value.

BITS_PER_SAMPLE

public static final COSName BITS_PER_SAMPLE

A common COSName value.

BOUNDS

public static final COSName BOUNDS

A common COSName value.

BPC

public static final COSName BPC

A common COSName value.

CATALOG

public static final COSName CATALOG

A common COSName value.

C

public static final COSName C

"C"

C0

public static final COSName C0

A common COSName value.

C1

public static final COSName C1

A common COSName value.

CA

public static final COSName CA

A common COSName value.

CA_NS

public static final COSName CA_NS

A common COSName value.

CALGRAY

public static final COSName CALGRAY

A common COSName value.

CALRGB

public static final COSName CALRGB

A common COSName value.

CCITTFAX_DECODE

public static final COSName CCITTFAX_DECODE

A common COSName value.

CCITTFAX_DECODE_ABBREVIATION

public static final COSName CCITTFAX_DECODE_ABBREVIATION

A common COSName value.

CF

public static final COSName CF

A common COSName value.

CFM

public static final COSName CFM

A common COSName value.

CHAR_PROCS

public static final COSName CHAR_PROCS

A common COSName value.

CHAR_SET

public static final COSName CHAR_SET

A common COSName value.

CID_FONT_TYPE0

public static final COSName CID_FONT_TYPE0

A common COSName value.

CID_FONT_TYPE2

public static final COSName CID_FONT_TYPE2

A common COSName value.

CIDSYSTEMINFO

public static final COSName CIDSYSTEMINFO

A common COSName value.

COLORANTS

public static final COSName COLORANTS

A common COSName value.

COLORSPACE

public static final COSName COLORSPACE

A common COSName value.

COLUMNS

public static final COSName COLUMNS

A common COSName value.

public static final COSName CONTENTS

A common COSName value.

COUNT

public static final COSName COUNT

A common COSName value.

CREATION_DATE

public static final COSName CREATION_DATE

A common COSName value.

CREATOR

public static final COSName CREATOR

A common COSName value.

CROP_BOX

public static final COSName CROP_BOX

A common COSName value.

CRYPT

public static final COSName CRYPT

The Crypt filter.

CS

public static final COSName CS

A common COSName value.

D

public static final COSName D

"D"

DCT_DECODE

public static final COSName DCT_DECODE

A common COSName value.

DCT_DECODE_ABBREVIATION

public static final COSName DCT_DECODE_ABBREVIATION

A common COSName value.

DECODE

public static final COSName DECODE

A common COSName value.

DECODE_PARMS

public static final COSName DECODE_PARMS

"DecodeParms"

DESCENDANT_FONTS

public static final COSName DESCENDANT_FONTS

A common COSName value.

DEST

public static final COSName DEST

A common COSName value.

DESTS

public static final COSName DESTS

"Dests"

DEVICECMYK

public static final COSName DEVICECMYK

A common COSName value.

DEVICEGRAY

public static final COSName DEVICEGRAY

A common COSName value.

DEVICEN

public static final COSName DEVICEN

A common COSName value.

DEVICERGB

public static final COSName DEVICERGB

A common COSName value.

DIFFERENCES

public static final COSName DIFFERENCES

A common COSName value.

DL

public static final COSName DL

"DL"

DOMAIN

public static final COSName DOMAIN

A common COSName value.

DP

public static final COSName DP

"DP"

DV

public static final COSName DV

A common COSName value.

DW

public static final COSName DW

A common COSName value.

E

public static final COSName E

"E"

EMBEDDED_FILES

public static final COSName EMBEDDED_FILES

"EmbeddedFiles"

ENCODE

public static final COSName ENCODE

A common COSName value.

ENCODING

public static final COSName ENCODING

A common COSName value.

ENCODING_90MS_RKSJ_H

public static final COSName ENCODING_90MS_RKSJ_H

A common COSName value.

ENCODING_90MS_RKSJ_V

public static final COSName ENCODING_90MS_RKSJ_V

A common COSName value.

ENCODING_ETEN_B5_H

public static final COSName ENCODING_ETEN_B5_H

A common COSName value.

ENCODING_ETEN_B5_V

public static final COSName ENCODING_ETEN_B5_V

A common COSName value.

ENCRYPT

public static final COSName ENCRYPT

"Encrypt"

ENCRYPT_META_DATA

public static final COSName ENCRYPT_META_DATA

"EncryptMetaData"

EXT_G_STATE

public static final COSName EXT_G_STATE

"ExtGState"

EXTENDS

public static final COSName EXTENDS

"Extends"

F

public static final COSName F

"F"

F_DECODE_PARMS

public static final COSName F_DECODE_PARMS

"FDecodeParms"

F_FILTER

public static final COSName F_FILTER

"FFilter"

FIELDS

public static final COSName FIELDS

A common COSName value.

FILTER

public static final COSName FILTER

A common COSName value.

FIRST_CHAR

public static final COSName FIRST_CHAR

A common COSName value.

FL

public static final COSName FL

A common COSName value.

FLATE_DECODE

public static final COSName FLATE_DECODE

A common COSName value.

FLATE_DECODE_ABBREVIATION

public static final COSName FLATE_DECODE_ABBREVIATION

A common COSName value.

FONT

public static final COSName FONT

A common COSName value.

FONT_BBOX

public static final COSName FONT_BBOX

A common COSName value.

FONT_FAMILY

public static final COSName FONT_FAMILY

A common COSName value.

FONT_FILE

public static final COSName FONT_FILE

A common COSName value.

FONT_FILE2

public static final COSName FONT_FILE2

A common COSName value.

FONT_FILE3

public static final COSName FONT_FILE3

A common COSName value.

FONT_DESC

public static final COSName FONT_DESC

A common COSName value.

FONT_MATRIX

public static final COSName FONT_MATRIX

A common COSName value.

FONT_NAME

public static final COSName FONT_NAME

A common COSName value.

FONT_STRETCH

public static final COSName FONT_STRETCH

A common COSName value.

FORMTYPE

public static final COSName FORMTYPE

A common COSName value.

FRM

public static final COSName FRM

A common COSName value.

FUNCTION_TYPE

public static final COSName FUNCTION_TYPE

A common COSName value.

FUNCTIONS

public static final COSName FUNCTIONS

A common COSName value.

GAMMA

public static final COSName GAMMA

A common COSName value.

H

public static final COSName H

A common COSName value.

HEIGHT

public static final COSName HEIGHT

A common COSName value.

ICCBASED

public static final COSName ICCBASED

A common COSName value.

ID

public static final COSName ID

"ID"

ID_TREE

public static final COSName ID_TREE

"IDTree"

IDENTITY

public static final COSName IDENTITY

A common COSName value.

IDENTITY_H

public static final COSName IDENTITY_H

A common COSName value.

IMAGE

public static final COSName IMAGE

A common COSName value.

IMAGE_MASK

public static final COSName IMAGE_MASK

A common COSName value.

INDEX

public static final COSName INDEX

"Index"

INDEXED

public static final COSName INDEXED

A common COSName value.

INFO

public static final COSName INFO

A common COSName value.

JAVA_SCRIPT

public static final COSName JAVA_SCRIPT

"JavaScript"

JBIG2_DECODE

public static final COSName JBIG2_DECODE

A common COSName value.

JPX_DECODE

public static final COSName JPX_DECODE

A common COSName value.

K

public static final COSName K

"K"

KEYWORDS

public static final COSName KEYWORDS

A common COSName value.

KIDS

public static final COSName KIDS

"Kids"

LAB

public static final COSName LAB

A common COSName value.

LANG

public static final COSName LANG

"Lang"

LAST_CHAR

public static final COSName LAST_CHAR

A common COSName value.

LC

public static final COSName LC

A common COSName value.

LENGTH

public static final COSName LENGTH

A common COSName value.

LENGTH1

public static final COSName LENGTH1

A common COSName value.

LIMITS

public static final COSName LIMITS

"Limits"

LJ

public static final COSName LJ

A common COSName value.

LW

public static final COSName LW

A common COSName value.

LZW_DECODE

public static final COSName LZW_DECODE

A common COSName value.

LZW_DECODE_ABBREVIATION

public static final COSName LZW_DECODE_ABBREVIATION

A common COSName value.

MAC_ROMAN_ENCODING

public static final COSName MAC_ROMAN_ENCODING

A common COSName value.

MARK_INFO

public static final COSName MARK_INFO

"MarkInfo"

MASK

public static final COSName MASK

A common COSName value.

MATRIX

public static final COSName MATRIX

A common COSName value.

MCID

public static final COSName MCID

"MCID"

MEDIA_BOX

public static final COSName MEDIA_BOX

A common COSName value.

METADATA

public static final COSName METADATA

A common COSName value.

ML

public static final COSName ML

A common COSName value.

MM_TYPE1

public static final COSName MM_TYPE1

A common COSName value.

MOD_DATE

public static final COSName MOD_DATE

A common COSName value.

N

public static final COSName N

A common COSName value.

NAME

public static final COSName NAME

A common COSName value.

NAMES

public static final COSName NAMES

"Names"

NUMS

public static final COSName NUMS

"Nums"

O

public static final COSName O

"O"

OBJ

public static final COSName OBJ

"Obj"

OC

public static final COSName OC

the COSName for the content group tag.

OCG

public static final COSName OCG

the COSName for an optional content group.

OCGS

public static final COSName OCGS

the COSName for the optional content group list.

OCPROPERTIES

public static final COSName OCPROPERTIES

the COSName for the optional content properties.

OFF

public static final COSName OFF

the COSName for the "OFF" value.

ON

public static final COSName ON

the COSName for the "ON" value.

OP

public static final COSName OP

A common COSName value.

OP_NS

public static final COSName OP_NS

A common COSName value.

OPM

public static final COSName OPM

A common COSName value.

OUTLINES

public static final COSName OUTLINES

"Outlines"

OPEN_ACTION

public static final COSName OPEN_ACTION

"OpenAction"

ORDER

public static final COSName ORDER

A common COSName value.

ORDERING

public static final COSName ORDERING

A common COSName value.

P

public static final COSName P

A common COSName value.

PAGE

public static final COSName PAGE

A common COSName value.

PAGE_LABELS

public static final COSName PAGE_LABELS

"PageLabels"

PAGE_LAYOUT

public static final COSName PAGE_LAYOUT

"PageLayout"

PAGE_MODE

public static final COSName PAGE_MODE

"PageMode"

PAGES

public static final COSName PAGES

A common COSName value.

PARENT

public static final COSName PARENT

A common COSName value.

PARENT_TREE_NEXT_KEY

public static final COSName PARENT_TREE_NEXT_KEY

"ParentTreeNextKey"

PATTERN

public static final COSName PATTERN

A common COSName value.

PDF_DOC_ENCODING

public static final COSName PDF_DOC_ENCODING

A common COSName value.

PG

public static final COSName PG

"Pg"

PREDICTOR

public static final COSName PREDICTOR

A common COSName value.

public static final COSName PREV

A common COSName value.

PROC_SET

public static final COSName PROC_SET

The COSName value for "ProcSet".

PRODUCER

public static final COSName PRODUCER

A common COSName value.

PROPERTIES

public static final COSName PROPERTIES

The COSName value for "Properties".

R

public static final COSName R

A common COSName value.

RANGE

public static final COSName RANGE

A common COSName value.

RECIPIENTS

public static final COSName RECIPIENTS

A common COSName value.

REGISTRY

public static final COSName REGISTRY

A common COSName value.

RESOURCES

public static final COSName RESOURCES

A common COSName value.

RI

public static final COSName RI

"RoleMap"

ROLE_MAP

public static final COSName ROLE_MAP

A common COSName value.

ROOT

public static final COSName ROOT

A common COSName value.

ROTATE

public static final COSName ROTATE

A common COSName value.

ROWS

public static final COSName ROWS

A common COSName value.

RUN_LENGTH_DECODE

public static final COSName RUN_LENGTH_DECODE

A common COSName value.

RUN_LENGTH_DECODE_ABBREVIATION

public static final COSName RUN_LENGTH_DECODE_ABBREVIATION

A common COSName value.

S

public static final COSName S

"S"

SA

public static final COSName SA

A common COSName value.

SEPARATION

public static final COSName SEPARATION

A common COSName value.

SHADING

public static final COSName SHADING

"Shading"

SM

public static final COSName SM

A common COSName value.

SMASK

public static final COSName SMASK

A common COSName value.

SIZE

public static final COSName SIZE

"Size"

STANDARD_ENCODING

public static final COSName STANDARD_ENCODING

A common COSName value.

STD_CF

public static final COSName STD_CF

A common COSName value.

STM_F

public static final COSName STM_F

A common COSName value.

STR_F

public static final COSName STR_F

A common COSName value.

STRUCT_TREE_ROOT

public static final COSName STRUCT_TREE_ROOT

"StructTreeRoot"

SUB_FILTER

public static final COSName SUB_FILTER

A common COSName value.

SUBJECT

public static final COSName SUBJECT

A common COSName value.

SUPPLEMENT

public static final COSName SUPPLEMENT

A common COSName value.

SUBTYPE

public static final COSName SUBTYPE

A common COSName value.

T

public static final COSName T

"T"

THREADS

public static final COSName THREADS

"Threads"

TITLE

public static final COSName TITLE

A common COSName value.

TK

public static final COSName TK

A common COSName value.

TRAPPED

public static final COSName TRAPPED

A common COSName value.

TRIM_BOX

public static final COSName TRIM_BOX

A common COSName value.

TRUE_TYPE

public static final COSName TRUE_TYPE

A common COSName value.

TO_UNICODE

public static final COSName TO_UNICODE

A common COSName value.

TYPE

public static final COSName TYPE

A common COSName value.

TYPE0

public static final COSName TYPE0

A common COSName value.

TYPE1

public static final COSName TYPE1

A common COSName value.

TYPE3

public static final COSName TYPE3

A common COSName value.

U

public static final COSName U

A common COSName value.

UNCHANGED

public static final COSName UNCHANGED

the COSName for the "Unchanged" value.

URI

public static final COSName URI

"URI"

V

public static final COSName V

A common COSName value.

VERSION

public static final COSName VERSION

A common COSName value.

VIEWER_PREFERENCES

public static final COSName VIEWER_PREFERENCES

"ViewerPreferences"

W

public static final COSName W

A common COSName value.

WIDTH

public static final COSName WIDTH

A common COSName value.

WIDTHS

public static final COSName WIDTHS

A common COSName value.

WIN_ANSI_ENCODING

public static final COSName WIN_ANSI_ENCODING

A common COSName value.

WHITE_POINT

public static final COSName WHITE_POINT

A common COSName value.

XOBJECT

public static final COSName XOBJECT

"XObject"

NAME_PREFIX

public static final byte[] NAME_PREFIX

The prefix to a PDF name.

NAME_ESCAPE

public static final byte[] NAME_ESCAPE

The escape character for a name.

Method Detail

getPDFName

public static final COSName getPDFName(String aName)

This will get a COSName object with that name.

Parameters:: aName - The name of the object.
Returns:: A COSName with the specified name.

getName

public String getName()

This will get the name of this COSName object.

Returns:: The name of the object.

toString

public String toString()

Overrides:: toString in class Object

equals

public boolean equals(Object o)

Overrides:: equals in class Object

hashCode

public int hashCode()

Overrides:: hashCode in class Object

compareTo

public int compareTo(COSName other)

Specified by:: compareTo in interface Comparable<COSName>

accept

public Object accept(ICOSVisitor visitor)
              throws COSVisitorException

visitor pattern double dispatch method.

Specified by:: accept in class COSBase

Parameters:: visitor - The object to notify when visiting this object.
Returns:: any object, depending on the visitor implementation, or null
Throws:: COSVisitorException - If an error occurs while visiting this object.

writePDF

public void writePDF(OutputStream output)
              throws IOException

This will output this string as a PDF object.

Parameters:: output - The stream to write to.
Throws:: IOException - If there is an error writing to the stream.

clearResources

public static void clearResources()

Not usually needed except if resources need to be reclaimed in a ong running process. Patch provided by [email protected] incorporated 5/23/08, [email protected]

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.pdfbox.cos Class COSName

A

AA

ACRO_FORM

ACTUAL_TEXT

AIS

ALT

ALTERNATE

ANNOTS

ARTIFACT

ART_BOX

ASCII85_DECODE

ASCII85_DECODE_ABBREVIATION

ATTACHED

ASCII_HEX_DECODE

ASCII_HEX_DECODE_ABBREVIATION

AP

AUTHOR

B

BASE_ENCODING

BASE_FONT

BASE_STATE

BBOX

BLACK_IS_1

BLACK_POINT

BLEED_BOX

BITS_PER_COMPONENT

BITS_PER_SAMPLE

BOUNDS

BPC

CATALOG

C

C0

C1

CA

CA_NS

CALGRAY

CALRGB

CCITTFAX_DECODE

CCITTFAX_DECODE_ABBREVIATION

CF

CFM

CHAR_PROCS

CHAR_SET

CID_FONT_TYPE0

CID_FONT_TYPE2

CIDSYSTEMINFO

COLORANTS

COLORSPACE

COLUMNS

CONTENTS

COUNT

CREATION_DATE

CREATOR

CROP_BOX

CRYPT

CS

D

DCT_DECODE

DCT_DECODE_ABBREVIATION

DECODE

DECODE_PARMS

DESCENDANT_FONTS

DEST

DESTS

DEVICECMYK

DEVICEGRAY

DEVICEN

DEVICERGB

DIFFERENCES

DL

DOMAIN

DP

DV

DW

E

EMBEDDED_FILES

ENCODE

ENCODING

ENCODING_90MS_RKSJ_H

org.apache.pdfbox.cos
Class COSName