Package 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
A PDF Name object.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
private final int
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
private final String
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
"Off", to be used for Acroform, not for OCGsstatic final COSName
"OFF", to be used for OCGs, not for Acroformstatic final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
Acro form field type for text field.static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
static final COSName
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccept
(ICOSVisitor visitor) visitor pattern double dispatch method.static void
Not usually needed except if resources need to be reclaimed in a long running process.int
boolean
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()
boolean
isEmpty()
Returns true if the name is the empty 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, isDirect, setDirect
-
Field Details
-
nameMap
-
commonNameMap
-
A
-
AA
-
ABSOLUTE_COLORIMETRIC
-
AC
-
ACRO_FORM
-
ACTUAL_TEXT
-
ADBE_PKCS7_DETACHED
-
ADBE_PKCS7_SHA1
-
ADBE_X509_RSA_SHA1
-
ADOBE_PPKLITE
-
AESV2
-
AESV3
-
AFTER
-
AI_META_DATA
-
AIS
-
ALL_OFF
-
ALL_ON
-
ALT
-
ALPHA
-
ALTERNATE
-
ANNOT
-
ANNOTS
-
ANTI_ALIAS
-
ANY_OFF
-
ANY_ON
-
AP
-
AP_REF
-
APP
-
ART_BOX
-
ARTIFACT
-
AS
-
ASCENT
-
ASCII_HEX_DECODE
-
ASCII_HEX_DECODE_ABBREVIATION
-
ASCII85_DECODE
-
ASCII85_DECODE_ABBREVIATION
-
ATTACHED
-
AUTHOR
-
AVG_WIDTH
-
B
-
BACKGROUND
-
BASE_ENCODING
-
BASE_FONT
-
BASE_STATE
-
BBOX
-
BC
-
BE
-
BEFORE
-
BG
-
BITS_PER_COMPONENT
-
BITS_PER_COORDINATE
-
BITS_PER_FLAG
-
BITS_PER_SAMPLE
-
BLACK_IS_1
-
BLACK_POINT
-
BLEED_BOX
-
BM
-
BORDER
-
BOUNDS
-
BPC
-
BS
-
BTN
-
BYTERANGE
-
C
-
C0
-
C1
-
CA
-
CA_NS
-
CALGRAY
-
CALRGB
-
CAP
-
CAP_HEIGHT
-
CATALOG
-
CCITTFAX_DECODE
-
CCITTFAX_DECODE_ABBREVIATION
-
CENTER_WINDOW
-
CERT
-
CF
-
CFM
-
CH
-
CHAR_PROCS
-
CHAR_SET
-
CI
-
CICI_SIGNIT
-
CID_FONT_TYPE0
-
CID_FONT_TYPE2
-
CID_TO_GID_MAP
-
CID_SET
-
CIDSYSTEMINFO
-
CL
-
CLR_F
-
CLR_FF
-
CMAP
-
CMAPNAME
-
CMYK
-
CO
-
COLOR
-
COLLECTION
-
COLLECTION_ITEM
-
COLLECTION_FIELD
-
COLLECTION_SCHEMA
-
COLLECTION_SORT
-
COLLECTION_SUBITEM
-
COLOR_BURN
-
COLOR_DODGE
-
COLORANTS
-
COLORS
-
COLORSPACE
-
COLUMNS
-
COMPATIBLE
-
COMPONENTS
-
CONTACT_INFO
-
CONTENTS
-
COORDS
-
COUNT
-
CP
-
CREATION_DATE
-
CREATOR
-
CROP_BOX
-
CRYPT
-
CS
-
D
-
DA
-
DARKEN
-
DATE
-
DCT_DECODE
-
DCT_DECODE_ABBREVIATION
-
DECODE
-
DECODE_PARMS
-
DEFAULT
-
DEFAULT_CMYK
-
DEFAULT_CRYPT_FILTER
-
DEFAULT_GRAY
-
DEFAULT_RGB
-
DESC
-
DESCENDANT_FONTS
-
DESCENT
-
DEST
-
DEST_OUTPUT_PROFILE
-
DESTS
-
DEVICECMYK
-
DEVICEGRAY
-
DEVICEN
-
DEVICERGB
-
DI
-
DIFFERENCE
-
DIFFERENCES
-
DIGEST_METHOD
-
DIGEST_RIPEMD160
-
DIGEST_SHA1
-
DIGEST_SHA256
-
DIGEST_SHA384
-
DIGEST_SHA512
-
DIRECTION
-
DISPLAY_DOC_TITLE
-
DL
-
DM
-
DOC
-
DOC_CHECKSUM
-
DOC_TIME_STAMP
-
DOCMDP
-
DOCUMENT
-
DOMAIN
-
DOS
-
DP
-
DR
-
DS
-
DUPLEX
-
DUR
-
DV
-
DW
-
DW2
-
E
-
EARLY_CHANGE
-
EF
-
EMBEDDED_FDFS
-
EMBEDDED_FILES
-
EMPTY
-
ENCODE
-
ENCODED_BYTE_ALIGN
-
ENCODING
-
ENCODING_90MS_RKSJ_H
-
ENCODING_90MS_RKSJ_V
-
ENCODING_ETEN_B5_H
-
ENCODING_ETEN_B5_V
-
ENCRYPT
-
ENCRYPT_META_DATA
-
END_OF_LINE
-
ENTRUST_PPKEF
-
EXCLUSION
-
EXT_G_STATE
-
EXTEND
-
EXTENDS
-
F
-
F_DECODE_PARMS
-
F_FILTER
-
FB
-
FDF
-
FF
-
FIELDS
-
FILESPEC
-
FILTER
-
FIRST
-
FIRST_CHAR
-
FIT_WINDOW
-
FL
-
FLAGS
-
FLATE_DECODE
-
FLATE_DECODE_ABBREVIATION
-
FOLDERS
-
FONT
-
FONT_BBOX
-
FONT_DESC
-
FONT_FAMILY
-
FONT_FILE
-
FONT_FILE2
-
FONT_FILE3
-
FONT_MATRIX
-
FONT_NAME
-
FONT_STRETCH
-
FONT_WEIGHT
-
FORM
-
FORMTYPE
-
FRM
-
FT
-
FUNCTION
-
FUNCTION_TYPE
-
FUNCTIONS
-
G
-
GAMMA
-
GROUP
-
GTS_PDFA1
-
H
-
HARD_LIGHT
-
HEIGHT
-
HELV
-
HIDE_MENUBAR
-
HIDE_TOOLBAR
-
HIDE_WINDOWUI
-
HUE
-
I
-
IC
-
ICCBASED
-
ID
-
ID_TREE
-
IDENTITY
-
IDENTITY_H
-
IDENTITY_V
-
IF
-
ILLUSTRATOR
-
IM
-
IMAGE
-
IMAGE_MASK
-
INDEX
-
INDEXED
-
INFO
-
INKLIST
-
INTENT
-
INTERPOLATE
-
IT
-
ITALIC_ANGLE
-
ISSUER
-
IX
-
JAVA_SCRIPT
-
JBIG2_DECODE
-
JBIG2_GLOBALS
-
JPX_DECODE
-
JS
-
K
-
KEYWORDS
-
KEY_USAGE
-
KIDS
-
L
-
LAB
-
LANG
-
LAST
-
LAST_CHAR
-
LAST_MODIFIED
-
LC
-
LE
-
LEADING
-
LEGAL_ATTESTATION
-
LENGTH
-
LENGTH1
-
LENGTH2
-
LIGHTEN
-
LIMITS
-
LJ
-
LL
-
LLE
-
LLO
-
LOCATION
-
LUMINOSITY
-
LW
-
LZW_DECODE
-
LZW_DECODE_ABBREVIATION
-
M
-
MAC
-
MAC_EXPERT_ENCODING
-
MAC_ROMAN_ENCODING
-
MARK_INFO
-
MASK
-
MATRIX
-
MATTE
-
MAX_LEN
-
MAX_WIDTH
-
MCID
-
MDP
-
MEDIA_BOX
-
MEASURE
-
METADATA
-
MISSING_WIDTH
-
MIX
-
MK
-
ML
-
MM_TYPE1
-
MOD_DATE
-
MULTIPLY
-
N
-
NAME
-
NAMES
-
NAVIGATOR
-
NEED_APPEARANCES
-
NEW_WINDOW
-
NEXT
-
NM
-
NON_EFONT_NO_WARN
-
NON_FULL_SCREEN_PAGE_MODE
-
NONE
-
NORMAL
-
NUMS
-
O
-
OBJ
-
OBJ_STM
-
OC
-
OCG
-
OCGS
-
OCMD
-
OCPROPERTIES
-
OE
-
OID
-
OFF
"OFF", to be used for OCGs, not for Acroform -
Off
"Off", to be used for Acroform, not for OCGs -
ON
-
OP
-
OP_NS
-
OPEN_ACTION
-
OPEN_TYPE
-
OPM
-
OPT
-
ORDER
-
ORDERING
-
OS
-
OUTLINES
-
OUTPUT_CONDITION
-
OUTPUT_CONDITION_IDENTIFIER
-
OUTPUT_INTENT
-
OUTPUT_INTENTS
-
OVERLAY
-
P
-
PAGE
-
PAGE_LABELS
-
PAGE_LAYOUT
-
PAGE_MODE
-
PAGES
-
PAINT_TYPE
-
PANOSE
-
PARAMS
-
PARENT
-
PARENT_TREE
-
PARENT_TREE_NEXT_KEY
-
PART
-
PATH
-
PATTERN
-
PATTERN_TYPE
-
PDF_DOC_ENCODING
-
PERMS
-
PERCEPTUAL
-
PIECE_INFO
-
PG
-
PRE_RELEASE
-
PREDICTOR
-
PREV
-
PRINT_AREA
-
PRINT_CLIP
-
PRINT_SCALING
-
PRIVATE
-
PROC_SET
-
PROCESS
-
PRODUCER
-
PROP_BUILD
-
PROPERTIES
-
PS
-
PUB_SEC
-
Q
-
QUADPOINTS
-
R
-
RANGE
-
RC
-
RD
-
REASON
-
REASONS
-
RELATIVE_COLORIMETRIC
-
REPEAT
-
RECIPIENTS
-
RECT
-
REFERENCE
-
REGISTRY
-
REGISTRY_NAME
-
RENAME
-
RESOURCES
-
RGB
-
RI
-
ROLE_MAP
-
ROOT
-
ROTATE
-
ROWS
-
RUN_LENGTH_DECODE
-
RUN_LENGTH_DECODE_ABBREVIATION
-
RV
-
S
-
SA
-
SATURATION
-
SCHEMA
-
SCREEN
-
SE
-
SEPARATION
-
SET_F
-
SET_FF
-
SHADING
-
SHADING_TYPE
-
SIG
-
SIG_FLAGS
-
SIG_REF
-
SIZE
-
SM
-
SMASK
-
SOFT_LIGHT
-
SORT
-
SOUND
-
SPLIT
-
SS
-
ST
-
STANDARD_ENCODING
-
STATE
-
STATE_MODEL
-
STATUS
-
STD_CF
-
STEM_H
-
STEM_V
-
STM_F
-
STR_F
-
STRUCT_ELEM
-
STRUCT_PARENT
-
STRUCT_PARENTS
-
STRUCT_TREE_ROOT
-
STYLE
-
SUB_FILTER
-
SUBJ
-
SUBJECT
-
SUBJECT_DN
-
SUBTYPE
-
SUPPLEMENT
-
SV
-
SV_CERT
-
SW
-
SY
-
SYNCHRONOUS
-
T
-
TARGET
-
TEMPLATES
-
THREADS
-
THUMB
-
TI
-
TILING_TYPE
-
TIME_STAMP
-
TITLE
-
TK
-
TM
-
TO_UNICODE
-
TR
-
TR2
-
TRAPPED
-
TRANS
-
TRANSFORM_METHOD
-
TRANSFORM_PARAMS
-
TRANSPARENCY
-
TREF
-
TRIM_BOX
-
TRUE_TYPE
-
TRUSTED_MODE
-
TU
-
TX
Acro form field type for text field. -
TYPE
-
TYPE0
-
TYPE1
-
TYPE3
-
U
-
UE
-
UF
-
UNCHANGED
-
UNIX
-
URI
-
URL
-
URL_TYPE
-
USER_UNIT
-
V
-
VE
-
VERISIGN_PPKVS
-
VERSION
-
VERTICES
-
VERTICES_PER_ROW
-
VIEW
-
VIEW_AREA
-
VIEW_CLIP
-
VIEWER_PREFERENCES
-
VOLUME
-
VP
-
W
-
W2
-
WHITE_POINT
-
WIDGET
-
WIDTH
-
WIDTHS
-
WIN_ANSI_ENCODING
-
XFA
-
X_STEP
-
XHEIGHT
-
XOBJECT
-
XREF
-
XREF_STM
-
Y_STEP
-
YES
-
ZA_DB
-
name
-
hashCode
private final int hashCode
-
-
Constructor Details
-
COSName
Private constructor. This will limit the number of COSName objects. that are created.- Parameters:
aName
- The name of the COSName object.staticValue
- Indicates if the COSName object is static so that it can be stored in the HashMap without synchronizing.
-
COSName
Private constructor. This will limit the number of COSName objects. that are created.- Parameters:
aName
- The name of the COSName object.
-
-
Method Details
-
getPDFName
This will get a COSName object with that name.- Parameters:
aName
- The name of the object.- Returns:
- A COSName with the specified name.
-
getName
This will get the name of this COSName object.- Returns:
- The name of the object.
-
toString
-
equals
-
hashCode
public int hashCode() -
compareTo
- Specified by:
compareTo
in interfaceComparable<COSName>
-
isEmpty
public boolean isEmpty()Returns true if the name is the empty string.- Returns:
- true if the name is the empty string.
-
accept
Description copied from class:COSBase
visitor pattern double dispatch method.- Specified by:
accept
in classCOSBase
- Parameters:
visitor
- The object to notify when visiting this object.- Returns:
- any object, depending on the visitor implementation, or null
- Throws:
IOException
- If an error occurs while visiting this object.
-
writePDF
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 long running process.
-