Top Description Fields Constructors Methods
org.apache.pdfbox.cos

public final Class COSName

extends COSBase
implements Comparable<COSName>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Imports
java.io.IOException, .OutputStream, java.nio.charset.StandardCharsets, java.util.HashMap, .Map, java.util.concurrent.ConcurrentHashMap, org.apache.pdfbox.util.Hex
A PDF Name object.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
public static final COSName
A

public static final COSName
AA

public static final COSName
ABSOLUTE_COLORIMETRIC

public static final COSName
AC

public static final COSName
ACRO_FORM

public static final COSName
ACTUAL_TEXT

public static final COSName
ADBE

public static final COSName
ADBE_PKCS7_DETACHED

public static final COSName
ADBE_PKCS7_SHA1

public static final COSName
ADBE_X509_RSA_SHA1

public static final COSName
ADOBE_PPKLITE

public static final COSName
AESV2

public static final COSName
AESV3

public static final COSName
AF

public static final COSName
AF_RELATIONSHIP

public static final COSName
AFTER

public static final COSName
AI_META_DATA

public static final COSName
AIS

public static final COSName
ALL_OFF

public static final COSName
ALL_ON

public static final COSName
ALPHA

public static final COSName
ALT

public static final COSName
ALTERNATE

public static final COSName
ANNOT

public static final COSName
ANNOTS

public static final COSName
ANTI_ALIAS

public static final COSName
ANY_OFF

public static final COSName
ANY_ON

public static final COSName
AP

public static final COSName
AP_REF

public static final COSName
APP

public static final COSName
ART_BOX

public static final COSName
ARTIFACT

public static final COSName
AS

public static final COSName
ASCENT

public static final COSName
ASCII85_DECODE

public static final COSName
ASCII85_DECODE_ABBREVIATION

public static final COSName
ASCII_HEX_DECODE

public static final COSName
ASCII_HEX_DECODE_ABBREVIATION

public static final COSName
ATTACHED

public static final COSName
AUTHOR

public static final COSName
AVG_WIDTH

public static final COSName
B

public static final COSName
BACKGROUND

public static final COSName
BASE_ENCODING

public static final COSName
BASE_FONT

public static final COSName
BASE_STATE

public static final COSName
BASE_VERSION

public static final COSName
BBOX

public static final COSName
BC

public static final COSName
BE

public static final COSName
BEAD

public static final COSName
BEFORE

public static final COSName
BG

public static final COSName
BITS_PER_COMPONENT

public static final COSName
BITS_PER_COORDINATE

public static final COSName
BITS_PER_FLAG

public static final COSName
BITS_PER_SAMPLE

public static final COSName
BL

public static final COSName
BLACK_IS_1

public static final COSName
BLACK_POINT

public static final COSName
BLEED_BOX

public static final COSName
BM

public static final COSName
BORDER

public static final COSName
BOUNDS

public static final COSName
BPC

public static final COSName
BS

public static final COSName
BTN

public static final COSName
BYTERANGE

public static final COSName
C

public static final COSName
C0

public static final COSName
C1

public static final COSName
CA

public static final COSName
CA_NS

public static final COSName
CALGRAY

public static final COSName
CALRGB

public static final COSName
CAP

public static final COSName
CAP_HEIGHT

public static final COSName
CATALOG

public static final COSName
CCITTFAX_DECODE

public static final COSName
CCITTFAX_DECODE_ABBREVIATION

public static final COSName
CENTER_WINDOW

public static final COSName
CERT

public static final COSName
CERTS

public static final COSName
CF

public static final COSName
CFM

public static final COSName
CH

public static final COSName
CHAR_PROCS

public static final COSName
CHAR_SET

public static final COSName
CHECK_SUM

public static final COSName
CI

public static final COSName
CICI_SIGNIT

public static final COSName
CID_FONT_TYPE0

public static final COSName
CID_FONT_TYPE2

public static final COSName
CID_SET

public static final COSName
CID_TO_GID_MAP

public static final COSName
CIDSYSTEMINFO

public static final COSName
CL

public static final COSName
CLASS_MAP

public static final COSName
CLR_F

public static final COSName
CLR_FF

public static final COSName
CMAP

public static final COSName
CMAPNAME

public static final COSName
CMYK

public static final COSName
CO

public static final COSName
COLLECTION

public static final COSName
COLLECTION_FIELD

public static final COSName
COLLECTION_ITEM

public static final COSName
COLLECTION_SCHEMA

public static final COSName
COLLECTION_SORT

public static final COSName
COLLECTION_SUBITEM

public static final COSName
COLOR

public static final COSName
COLOR_BURN

public static final COSName
COLOR_DODGE

public static final COSName
COLORANTS

public static final COSName
COLORS

public static final COSName
COLORSPACE

public static final COSName
COLUMNS

private static final Map<String, COSName>
commonNameMap

public static final COSName
COMPATIBLE

public static final COSName
COMPONENTS

public static final COSName
CONTACT_INFO

public static final COSName
CONTENTS

public static final COSName
COORDS

public static final COSName
COUNT

public static final COSName
CP

public static final COSName
CREATION_DATE

public static final COSName
CREATOR

public static final COSName
CRL

public static final COSName
CRLS

public static final COSName
CROP_BOX

public static final COSName
CRYPT

public static final COSName
CS

public static final COSName
CYX

public static final COSName
D

public static final COSName
DA

public static final COSName
DARKEN

public static final COSName
DATE

public static final COSName
DCT_DECODE

public static final COSName
DCT_DECODE_ABBREVIATION

public static final COSName
DECODE

public static final COSName
DECODE_PARMS

public static final COSName
DEFAULT

public static final COSName
DEFAULT_CMYK

public static final COSName
DEFAULT_CRYPT_FILTER

public static final COSName
DEFAULT_GRAY

public static final COSName
DEFAULT_RGB

public static final COSName
DESC

public static final COSName
DESCENDANT_FONTS

public static final COSName
DESCENT

public static final COSName
DEST

public static final COSName
DEST_OUTPUT_PROFILE

public static final COSName
DESTS

public static final COSName
DEVICECMYK

public static final COSName
DEVICEGRAY

public static final COSName
DEVICEN

public static final COSName
DEVICERGB

public static final COSName
DI

public static final COSName
DIFFERENCE

public static final COSName
DIFFERENCES

public static final COSName
DIGEST_METHOD

public static final COSName
DIGEST_RIPEMD160

public static final COSName
DIGEST_SHA1

public static final COSName
DIGEST_SHA256

public static final COSName
DIGEST_SHA384

public static final COSName
DIGEST_SHA512

public static final COSName
DIRECTION

public static final COSName
DISPLAY_DOC_TITLE

public static final COSName
DL

public static final COSName
DM

public static final COSName
DOC

public static final COSName
DOC_CHECKSUM

public static final COSName
DOC_TIME_STAMP

public static final COSName
DOCMDP

public static final COSName
DOCUMENT

public static final COSName
DOMAIN

public static final COSName
DOS

public static final COSName
DP

public static final COSName
DR

public static final COSName
DS

public static final COSName
DSS

public static final COSName
DUPLEX

public static final COSName
DUR

public static final COSName
DV

public static final COSName
DW

public static final COSName
DW2

public static final COSName
E

public static final COSName
EARLY_CHANGE

public static final COSName
EF

public static final COSName
EMBEDDED_FDFS

public static final COSName
EMBEDDED_FILE

public static final COSName
EMBEDDED_FILES

public static final COSName
EMPTY

public static final COSName
ENCODE

public static final COSName
ENCODED_BYTE_ALIGN

public static final COSName
ENCODING

public static final COSName
ENCODING_90MS_RKSJ_H

public static final COSName
ENCODING_90MS_RKSJ_V

public static final COSName
ENCODING_ETEN_B5_H

public static final COSName
ENCODING_ETEN_B5_V

public static final COSName
ENCRYPT

public static final COSName
ENCRYPT_META_DATA

public static final COSName
ENCRYPTED_PAYLOAD

public static final COSName
END_OF_LINE

public static final COSName
ENTRUST_PPKEF

public static final COSName
EX_DATA

public static final COSName
EXCLUSION

public static final COSName
EXPORT

public static final COSName
EXPORT_STATE

public static final COSName
EXT_G_STATE

public static final COSName
EXTEND

public static final COSName
EXTENDS

public static final COSName
EXTENSION_LEVEL

public static final COSName
EXTENSIONS

public static final COSName
F

public static final COSName
F_DECODE_PARMS

public static final COSName
F_FILTER

public static final COSName
FB

public static final COSName
FDF

public static final COSName
FF

public static final COSName
FIELDS

public static final COSName
FILESPEC

public static final COSName
FILTER

public static final COSName
FIRST

public static final COSName
FIRST_CHAR

public static final COSName
FIT_WINDOW

public static final COSName
FL

public static final COSName
FLAGS

public static final COSName
FLATE_DECODE

public static final COSName
FLATE_DECODE_ABBREVIATION

public static final COSName
FO

public static final COSName
FOLDERS

public static final COSName
FONT

public static final COSName
FONT_BBOX

public static final COSName
FONT_DESC

public static final COSName
FONT_FAMILY

public static final COSName
FONT_FILE

public static final COSName
FONT_FILE2

public static final COSName
FONT_FILE3

public static final COSName
FONT_MATRIX

public static final COSName
FONT_NAME

public static final COSName
FONT_STRETCH

public static final COSName
FONT_WEIGHT

public static final COSName
FORM

public static final COSName
FORMTYPE

public static final COSName
FRM

public static final COSName
FS

public static final COSName
FT

public static final COSName
FUNCTION

public static final COSName
FUNCTION_TYPE

public static final COSName
FUNCTIONS

public static final COSName
G

public static final COSName
GAMMA

public static final COSName
GROUP

public static final COSName
GTS_PDFA1

public static final COSName
H

public static final COSName
HARD_LIGHT

public static final COSName
HEIGHT

public static final COSName
HELV

public static final COSName
HIDE_MENUBAR

public static final COSName
HIDE_TOOLBAR

public static final COSName
HIDE_WINDOWUI

public static final COSName
HUE

public static final COSName
I

public static final COSName
IC

public static final COSName
ICCBASED

public static final COSName
ID

public static final COSName
ID_TREE

public static final COSName
IDENTITY

public static final COSName
IDENTITY_H

public static final COSName
IDENTITY_V

public static final COSName
IF

public static final COSName
ILLUSTRATOR

public static final COSName
IM

public static final COSName
IMAGE

public static final COSName
IMAGE_MASK

public static final COSName
INDEX

public static final COSName
INDEXED

public static final COSName
INFO

public static final COSName
INKLIST

public static final COSName
INTENT

public static final COSName
INTERPOLATE

public static final COSName
IRT

public static final COSName
ISSUER

public static final COSName
IT

public static final COSName
ITALIC_ANGLE

public static final COSName
IX

public static final COSName
JAVA_SCRIPT

public static final COSName
JBIG2_DECODE

public static final COSName
JBIG2_GLOBALS

public static final COSName
JPX_DECODE

public static final COSName
JS

public static final COSName
K

public static final COSName
KEY_USAGE

public static final COSName
KEYWORDS

public static final COSName
KIDS

public static final COSName
L

public static final COSName
LAB

public static final COSName
LANG

public static final COSName
LAST

public static final COSName
LAST_CHAR

public static final COSName
LAST_MODIFIED

public static final COSName
LC

public static final COSName
LE

public static final COSName
LEADING

public static final COSName
LENGTH

public static final COSName
LENGTH1

public static final COSName
LENGTH2

public static final COSName
LENGTH3

public static final COSName
LIGHTEN

public static final COSName
LIMITS

public static final COSName
LINEARIZED

public static final COSName
LINK

public static final COSName
LJ

public static final COSName
LL

public static final COSName
LLE

public static final COSName
LLO

public static final COSName
LOCATION

public static final COSName
LUMINOSITY

public static final COSName
LW

public static final COSName
LZW_DECODE

public static final COSName
LZW_DECODE_ABBREVIATION

public static final COSName
M

public static final COSName
MAC

public static final COSName
MAC_EXPERT_ENCODING

public static final COSName
MAC_ROMAN_ENCODING

public static final COSName
MARK_INFO

public static final COSName
MASK

public static final COSName
MATRIX

public static final COSName
MATTE

public static final COSName
MAX_LEN

public static final COSName
MAX_WIDTH

public static final COSName
MCID

public static final COSName
MDP

public static final COSName
MEASURE

public static final COSName
MEDIA_BOX

public static final COSName
METADATA

public static final COSName
MISSING_WIDTH

public static final COSName
MIX

public static final COSName
MK

public static final COSName
ML

public static final COSName
MM_TYPE1

public static final COSName
MOD_DATE

public static final COSName
MULTIPLY

public static final COSName
N

public static final COSName
NAME

private final String
name

private static final Map<String, COSName>
nameMap

public static final COSName
NAMES

public static final COSName
NEED_APPEARANCES

public static final COSName
NEW_WINDOW

public static final COSName
NEXT

public static final COSName
NM

public static final COSName
NON_EFONT_NO_WARN

public static final COSName
NON_FULL_SCREEN_PAGE_MODE

public static final COSName
NONE

public static final COSName
NORMAL

public static final COSName
NUMS

public static final COSName
O

public static final COSName
OBJ

public static final COSName
OBJ_STM

public static final COSName
OBJR

public static final COSName
OC

public static final COSName
OCG

public static final COSName
OCGS

public static final COSName
OCMD

public static final COSName
OCPROPERTIES

public static final COSName
OCSP

public static final COSName
OCSPS

public static final COSName
OE

public static final COSName
OFF

"OFF", to be used for OCGs, not for Acroform

public static final COSName
Off

"Off", to be used for Acroform, not for OCGs

public static final COSName
OID

public static final COSName
ON

public static final COSName
OP

public static final COSName
OP_NS

public static final COSName
OPEN_ACTION

public static final COSName
OPEN_TYPE

public static final COSName
OPM

public static final COSName
OPT

public static final COSName
ORDER

public static final COSName
ORDERING

public static final COSName
OS

public static final COSName
OUTLINES

public static final COSName
OUTPUT_CONDITION

public static final COSName
OUTPUT_CONDITION_IDENTIFIER

public static final COSName
OUTPUT_INTENT

public static final COSName
OUTPUT_INTENTS

public static final COSName
OVERLAY

public static final COSName
P

public static final COSName
PA

public static final COSName
PAGE

public static final COSName
PAGE_LABELS

public static final COSName
PAGE_LAYOUT

public static final COSName
PAGE_MODE

public static final COSName
PAGES

public static final COSName
PAINT_TYPE

public static final COSName
PANOSE

public static final COSName
PARAMS

public static final COSName
PARENT

public static final COSName
PARENT_TREE

public static final COSName
PARENT_TREE_NEXT_KEY

public static final COSName
PART

public static final COSName
PATH

public static final COSName
PATTERN

public static final COSName
PATTERN_TYPE

public static final COSName
PC

public static final COSName
PDF_DOC_ENCODING

public static final COSName
PERCEPTUAL

public static final COSName
PERMS

public static final COSName
PG

public static final COSName
PI

public static final COSName
PIECE_INFO

public static final COSName
PO

public static final COSName
POPUP

public static final COSName
PRE_RELEASE

public static final COSName
PREDICTOR

public static final COSName
PREV

public static final COSName
PRINT

public static final COSName
PRIVATE

public static final COSName
PROC_SET

public static final COSName
PROCESS

public static final COSName
PRODUCER

public static final COSName
PROP_BUILD

public static final COSName
PROPERTIES

public static final COSName
PS

public static final COSName
PUB_SEC

public static final COSName
PV

public static final COSName
Q

public static final COSName
QUADPOINTS

public static final COSName
R

public static final COSName
RANGE

public static final COSName
RC

public static final COSName
RD

public static final COSName
REASON

public static final COSName
REASONS

public static final COSName
RECIPIENTS

public static final COSName
RECT

public static final COSName
REFERENCE

public static final COSName
REGISTRY

public static final COSName
REGISTRY_NAME

public static final COSName
RELATIVE_COLORIMETRIC

public static final COSName
RENAME

public static final COSName
REPEAT

public static final COSName
RES_FORK

public static final COSName
RESOURCES

public static final COSName
RGB

public static final COSName
RI

public static final COSName
ROLE_MAP

public static final COSName
ROOT

public static final COSName
ROTATE

public static final COSName
ROWS

public static final COSName
RT

public static final COSName
RUN_LENGTH_DECODE

public static final COSName
RUN_LENGTH_DECODE_ABBREVIATION

public static final COSName
RV

public static final COSName
S

public static final COSName
SA

public static final COSName
SATURATION

public static final COSName
SCHEMA

public static final COSName
SCREEN

public static final COSName
SE

public static final COSName
SEPARATION

public static final COSName
SET_F

public static final COSName
SET_FF

public static final COSName
SHADING

public static final COSName
SHADING_TYPE

public static final COSName
SIG

public static final COSName
SIG_FLAGS

public static final COSName
SIG_REF

public static final COSName
SIZE

public static final COSName
SM

public static final COSName
SMASK

public static final COSName
SMASK_IN_DATA

public static final COSName
SOFT_LIGHT

public static final COSName
SORT

public static final COSName
SOUND

public static final COSName
SPLIT

public static final COSName
SS

public static final COSName
ST

public static final COSName
STANDARD_ENCODING

public static final COSName
STATE

public static final COSName
STATE_MODEL

public static final COSName
STATUS

public static final COSName
STD_CF

public static final COSName
STEM_H

public static final COSName
STEM_V

public static final COSName
STM_F

public static final COSName
STR_F

public static final COSName
STRUCT_ELEM

public static final COSName
STRUCT_PARENT

public static final COSName
STRUCT_PARENTS

public static final COSName
STRUCT_TREE_ROOT

public static final COSName
STYLE

public static final COSName
SUB_FILTER

public static final COSName
SUBJ

public static final COSName
SUBJECT

public static final COSName
SUBJECT_DN

public static final COSName
SUBTYPE

public static final COSName
SUPPLEMENT

public static final COSName
SV

public static final COSName
SV_CERT

public static final COSName
SW

public static final COSName
SY

public static final COSName
SYNCHRONOUS

public static final COSName
T

public static final COSName
TARGET

public static final COSName
TEMPLATES

public static final COSName
THREAD

public static final COSName
THREADS

public static final COSName
THREE_DD

public static final COSName
THUMB

public static final COSName
TI

public static final COSName
TILING_TYPE

public static final COSName
TIME_STAMP

public static final COSName
TITLE

public static final COSName
TK

public static final COSName
TM

public static final COSName
TO_UNICODE

public static final COSName
TR

public static final COSName
TR2

public static final COSName
TRANS

public static final COSName
TRANSFORM_METHOD

public static final COSName
TRANSFORM_PARAMS

public static final COSName
TRANSPARENCY

public static final COSName
TRAPPED

public static final COSName
TREF

public static final COSName
TRIM_BOX

public static final COSName
TRUE_TYPE

public static final COSName
TRUSTED_MODE

public static final COSName
TU

public static final COSName
TX

Acro form field type for text field.

public static final COSName
TYPE

public static final COSName
TYPE0

public static final COSName
TYPE1

public static final COSName
TYPE3

public static final COSName
U

public static final COSName
UE

public static final COSName
UF

public static final COSName
UNCHANGED

public static final COSName
UNIX

public static final COSName
URI

public static final COSName
URL

public static final COSName
URL_TYPE

public static final COSName
USAGE

public static final COSName
USE_CMAP

public static final COSName
USER_UNIT

public static final COSName
V

public static final COSName
VE

public static final COSName
VERISIGN_PPKVS

public static final COSName
VERSION

public static final COSName
VERTICES

public static final COSName
VERTICES_PER_ROW

public static final COSName
VIEW

public static final COSName
VIEW_AREA

public static final COSName
VIEW_CLIP

public static final COSName
VIEW_STATE

public static final COSName
VIEWER_PREFERENCES

public static final COSName
VOLUME

public static final COSName
VP

public static final COSName
VRI

public static final COSName
W

public static final COSName
W2

public static final COSName
WC

public static final COSName
WHITE_POINT

public static final COSName
WIDGET

public static final COSName
WIDTH

public static final COSName
WIDTHS

public static final COSName
WIN

public static final COSName
WIN_ANSI_ENCODING

public static final COSName
WMODE

public static final COSName
WP

public static final COSName
WS

public static final COSName
X

public static final COSName
X_STEP

public static final COSName
XFA

public static final COSName
XHEIGHT

public static final COSName
XOBJECT

public static final COSName
XREF

public static final COSName
XREF_STM

public static final COSName
Y

public static final COSName
Y_STEP

public static final COSName
YES

public static final COSName
ZA_DB

Constructor Summary

AccessConstructor and Description
private
COSName(String
The name of the COSName object.
aName, boolean
Indicates if the COSName object is static so that it can be stored in the HashMap without synchronizing.
staticValue)

Private constructor.

private
COSName(String
The name of the COSName object.
aName)

Private constructor.

Method Summary

Modifier and TypeMethod and Description
public void
accept(ICOSVisitor
The object to notify when visiting this object.
visitor)

Implements abstract org.apache.pdfbox.cos.COSBase.accept.

visitor pattern double dispatch method.

public static void
clearResources()
Deprecated will be removed in 4.0.0

Not usually needed except if resources need to be reclaimed in a long running process.

public int
compareTo(COSName
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public boolean
equals(Object
the reference object with which to compare.
object)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String

Returns:

The name of the object.
getName()

This will get the name of this COSName object.

public static COSName

Returns:

A COSName with the specified name.
getPDFName(String
The name of the object.
aName)

This will get a COSName object with that name.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean

Returns:

true if the name is the empty string.
isEmpty()

Returns true if the name is the empty string.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
writePDF(OutputStream
The stream to write to.
output)

This will output this string as a PDF object.

Inherited from org.apache.pdfbox.cos.COSBase:
getCOSObjectgetKeyisDirectsetDirectsetKey