COSArray (x-easypdf-pdfbox 3.0.0 API)

java.lang.Object
- org.apache.pdfbox.cos.COSBase
- - org.apache.pdfbox.cos.COSArray

所有已实现的接口:

Iterable<org.apache.pdfbox.cos.COSBase>, org.apache.pdfbox.cos.COSUpdateInfo, org.apache.pdfbox.pdmodel.common.COSObjectable
```
public class COSArray
extends org.apache.pdfbox.cos.COSBase
implements Iterable<org.apache.pdfbox.cos.COSBase>, org.apache.pdfbox.cos.COSUpdateInfo
```
从以下版本开始:

1.8
Copyright (c) 2020 xsx All Rights Reserved. x-easypdf is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

作者:

xsx

构造器概要

构造器
构造器和说明

COSArray()
Constructor.

COSArray(List<? extends org.apache.pdfbox.pdmodel.common.COSObjectable> cosObjectables)
Use the given list to initialize the COSArray.

构造器
构造器和说明
`COSArray()` Constructor.
`COSArray(List<? extends org.apache.pdfbox.pdmodel.common.COSObjectable> cosObjectables)` Use the given list to initialize the COSArray.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`accept(org.apache.pdfbox.cos.ICOSVisitor visitor)` Visitor pattern double dispatch method.
`void`	`add(org.apache.pdfbox.cos.COSBase object)` This will add an object to the array.
`void`	`add(org.apache.pdfbox.pdmodel.common.COSObjectable object)` This will add an object to the array.
`void`	`add(int i, org.apache.pdfbox.cos.COSBase object)` Add the specified object at the ith location and push the rest to the right.
`void`	`addAll(Collection<org.apache.pdfbox.cos.COSBase> objectsList)` This will add an object to the array.
`void`	`addAll(COSArray objectList)` This will add all objects to this array.
`void`	`addAll(int i, Collection<org.apache.pdfbox.cos.COSBase> objectList)` Add the specified object at the ith location and push the rest to the right.
`void`	`clear()` This will remove all of the objects in the collection.
`org.apache.pdfbox.cos.COSBase`	`get(int index)` This will get an object from the array.
`void`	`getIndirectObjectKeys(List<org.apache.pdfbox.cos.COSObjectKey> indirectObjects)` Collects all indirect objects numbers within this COSArray and all included dictionaries.
`int`	`getInt(int index)` Get the value of the array as an integer.
`int`	`getInt(int index, int defaultValue)` Get the value of the array as an integer, return the default if it does not exist.
`String`	`getName(int index)` Get the value of the array as a string.
`String`	`getName(int index, String defaultValue)` Get an entry in the array that is expected to be a COSName.
`org.apache.pdfbox.cos.COSBase`	`getObject(int index)` This will get an object from the array.
`String`	`getString(int index)` Get the value of the array as a string.
`String`	`getString(int index, String defaultValue)` Get an entry in the array that is expected to be a COSName.
`org.apache.pdfbox.cos.COSUpdateState`	`getUpdateState()` Returns the current `COSUpdateState` of this `COSArray`.
`void`	`growToSize(int size)` This will add null values until the size of the array is at least as large as the parameter.
`void`	`growToSize(int size, org.apache.pdfbox.cos.COSBase object)` This will add the object until the size of the array is at least as large as the parameter.
`int`	`indexOf(org.apache.pdfbox.cos.COSBase object)` This will return the index of the entry or -1 if it is not found.
`int`	`indexOfObject(org.apache.pdfbox.cos.COSBase object)` This will return the index of the entry or -1 if it is not found.
`Iterator<org.apache.pdfbox.cos.COSBase>`	`iterator()` Get access to the list.
`static COSArray`	`ofCOSIntegers(List<Integer> integer)` This will take a list of integer objects and return a COSArray of COSInteger objects.
`static COSArray`	`ofCOSNames(List<String> strings)` This will take a list of string objects and return a COSArray of COSName objects.
`static COSArray`	`ofCOSStrings(List<String> strings)` This will take a list of string objects and return a COSArray of COSName objects.
`boolean`	`remove(org.apache.pdfbox.cos.COSBase o)` This will remove an element from the array.
`org.apache.pdfbox.cos.COSBase`	`remove(int i)` This will remove an element from the array.
`void`	`removeAll(Collection<org.apache.pdfbox.cos.COSBase> objectsList)` This will remove all of the objects in the collection.
`boolean`	`removeObject(org.apache.pdfbox.cos.COSBase o)` This will remove an element from the array.
`void`	`retainAll(Collection<org.apache.pdfbox.cos.COSBase> objectsList)` This will retain all of the objects in the collection.
`void`	`set(int index, org.apache.pdfbox.cos.COSBase object)` This will set an object at a specific index.
`void`	`set(int index, org.apache.pdfbox.pdmodel.common.COSObjectable object)` This will set an object at a specific index.
`void`	`set(int index, int intVal)` This will set an object at a specific index.
`void`	`setFloatArray(float[] value)` Clear the current contents of the COSArray and set it with the float[].
`void`	`setInt(int index, int value)` Set the value in the array as an integer.
`void`	`setName(int index, String name)` Set the value in the array as a name.
`void`	`setString(int index, String string)` Set the value in the array as a string.
`int`	`size()` This will get the size of this array.
`List<String>`	`toCOSNameStringList()` This will return a list of names if the COSArray consists of COSNames only.
`List<Float>`	`toCOSNumberFloatList()` This will return a list of float values if the COSArray consists of COSNumbers only.
`List<Integer>`	`toCOSNumberIntegerList()` This will return a list of int values if the COSArray consists of COSNumbers only.
`List<String>`	`toCOSStringStringList()` This will return a list of names if the COSArray consists of COSStrings only.
`float[]`	`toFloatArray()` This will take an COSArray of numbers and convert it to a float[].
`List<? extends org.apache.pdfbox.cos.COSBase>`	`toList()` Return contents of COSArray as a Java List.
`String`	`toString()`

从类继承的方法 org.apache.pdfbox.cos.COSBase
getCOSObject, getKey, isDirect, setDirect, setKey

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.lang.Iterable
forEach, spliterator

从接口继承的方法 org.apache.pdfbox.cos.COSUpdateInfo
isNeedToBeUpdated, setNeedToBeUpdated, toIncrement

从接口继承的方法 org.apache.pdfbox.pdmodel.common.COSObjectable
getCOSObject

- 构造器详细资料
  - COSArray
```
public COSArray()
```
    Constructor.
  - COSArray
```
public COSArray(List<? extends org.apache.pdfbox.pdmodel.common.COSObjectable> cosObjectables)
```
    Use the given list to initialize the COSArray.
    
    参数:
    
    cosObjectables - the initial list of COSObjectables
- 方法详细资料
  - add
```
public void add(org.apache.pdfbox.cos.COSBase object)
```
    This will add an object to the array.
    
    参数:
    
    object - The object to add to the array.
  - add
```
public void add(org.apache.pdfbox.pdmodel.common.COSObjectable object)
```
    This will add an object to the array.
    
    参数:
    
    object - The object to add to the array.
  - add
```
public void add(int i,
                org.apache.pdfbox.cos.COSBase object)
```
    Add the specified object at the ith location and push the rest to the right.
    
    参数:
    
    i - The index to add at.
    
    object - The object to add at that index.
  - clear
```
public void clear()
```
    This will remove all of the objects in the collection.
  - removeAll
```
public void removeAll(Collection<org.apache.pdfbox.cos.COSBase> objectsList)
```
    This will remove all of the objects in the collection.
    
    参数:
    
    objectsList - The list of objects to remove from the collection.
  - retainAll
```
public void retainAll(Collection<org.apache.pdfbox.cos.COSBase> objectsList)
```
    This will retain all of the objects in the collection.
    
    参数:
    
    objectsList - The list of objects to retain from the collection.
  - addAll
```
public void addAll(Collection<org.apache.pdfbox.cos.COSBase> objectsList)
```
    This will add an object to the array.
    
    参数:
    
    objectsList - The object to add to the array.
  - addAll
```
public void addAll(COSArray objectList)
```
    This will add all objects to this array.
    
    参数:
    
    objectList - The list of objects to add.
  - addAll
```
public void addAll(int i,
                   Collection<org.apache.pdfbox.cos.COSBase> objectList)
```
    Add the specified object at the ith location and push the rest to the right.
    
    参数:
    
    i - The index to add at.
    
    objectList - The object to add at that index.
  - set
```
public void set(int index,
                org.apache.pdfbox.cos.COSBase object)
```
    This will set an object at a specific index.
    
    参数:
    
    index - zero based index into array.
    
    object - The object to set.
  - set
```
public void set(int index,
                int intVal)
```
    This will set an object at a specific index.
    
    参数:
    
    index - zero based index into array.
    
    intVal - The object to set.
  - set
```
public void set(int index,
                org.apache.pdfbox.pdmodel.common.COSObjectable object)
```
    This will set an object at a specific index.
    
    参数:
    
    index - zero based index into array.
    
    object - The object to set.
  - getObject
```
public org.apache.pdfbox.cos.COSBase getObject(int index)
```
    This will get an object from the array. This will dereference the object. If the object is COSNull then null will be returned.
    
    参数:
    
    index - The index into the array to get the object.
    
    返回:
    
    The object at the requested index.
  - get
```
public org.apache.pdfbox.cos.COSBase get(int index)
```
    This will get an object from the array. This will NOT dereference the COS object.
    
    参数:
    
    index - The index into the array to get the object.
    
    返回:
    
    The object at the requested index.
  - getInt
```
public int getInt(int index)
```
    Get the value of the array as an integer.
    
    参数:
    
    index - The index into the list.
    
    返回:
    
    The value at that index or -1 if does not exist.
  - getInt
```
public int getInt(int index,
                  int defaultValue)
```
    Get the value of the array as an integer, return the default if it does not exist.
    
    参数:
    
    index - The value of the array.
    
    defaultValue - The value to return if the value is null.
    
    返回:
    
    The value at the index or the defaultValue.
  - setInt
```
public void setInt(int index,
                   int value)
```
    Set the value in the array as an integer.
    
    参数:
    
    index - The index into the array.
    
    value - The value to set.
  - setName
```
public void setName(int index,
                    String name)
```
    Set the value in the array as a name.
    
    参数:
    
    index - The index into the array.
    
    name - The name to set in the array.
  - getName
```
public String getName(int index)
```
    Get the value of the array as a string.
    
    参数:
    
    index - The index into the array.
    
    返回:
    
    The name converted to a string or null if it does not exist.
  - getName
```
public String getName(int index,
                      String defaultValue)
```
    Get an entry in the array that is expected to be a COSName.
    
    参数:
    
    index - The index into the array.
    
    defaultValue - The value to return if it is null.
    
    返回:
    
    The value at the index or defaultValue if none is found.
  - setString
```
public void setString(int index,
                      String string)
```
    Set the value in the array as a string.
    
    参数:
    
    index - The index into the array.
    
    string - The string to set in the array.
  - getString
```
public String getString(int index)
```
    Get the value of the array as a string.
    
    参数:
    
    index - The index into the array.
    
    返回:
    
    The string or null if it does not exist.
  - getString
```
public String getString(int index,
                        String defaultValue)
```
    Get an entry in the array that is expected to be a COSName.
    
    参数:
    
    index - The index into the array.
    
    defaultValue - The value to return if it is null.
    
    返回:
    
    The value at the index or defaultValue if none is found.
  - size
```
public int size()
```
    This will get the size of this array.
    
    返回:
    
    The number of elements in the array.
  - remove
```
public org.apache.pdfbox.cos.COSBase remove(int i)
```
    This will remove an element from the array.
    
    参数:
    
    i - The index of the object to remove.
    
    返回:
    
    The object that was removed.
  - remove
```
public boolean remove(org.apache.pdfbox.cos.COSBase o)
```
    This will remove an element from the array.
    
    参数:
    
    o - The object to remove.
    
    返回:
    
    true if the object was removed, false otherwise
  - removeObject
```
public boolean removeObject(org.apache.pdfbox.cos.COSBase o)
```
    This will remove an element from the array. This method will also remove a reference to the object.
    
    参数:
    
    o - The object to remove.
    
    返回:
    
    true if the object was removed, false otherwise
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - iterator
```
public Iterator<org.apache.pdfbox.cos.COSBase> iterator()
```
    Get access to the list.
    
    指定者:
    
    iterator 在接口中 Iterable<org.apache.pdfbox.cos.COSBase>
    
    返回:
    
    an iterator over the array elements
  - indexOf
```
public int indexOf(org.apache.pdfbox.cos.COSBase object)
```
    This will return the index of the entry or -1 if it is not found.
    
    参数:
    
    object - The object to search for.
    
    返回:
    
    The index of the object or -1.
  - indexOfObject
```
public int indexOfObject(org.apache.pdfbox.cos.COSBase object)
```
    This will return the index of the entry or -1 if it is not found. This method will also find references to indirect objects.
    
    参数:
    
    object - The object to search for.
    
    返回:
    
    The index of the object or -1.
  - growToSize
```
public void growToSize(int size)
```
    This will add null values until the size of the array is at least as large as the parameter. If the array is already larger than the parameter then nothing is done.
    
    参数:
    
    size - The desired size of the array.
  - growToSize
```
public void growToSize(int size,
                       org.apache.pdfbox.cos.COSBase object)
```
    This will add the object until the size of the array is at least as large as the parameter. If the array is already larger than the parameter then nothing is done.
    
    参数:
    
    size - The desired size of the array.
    
    object - The object to fill the array with.
  - accept
```
public void accept(org.apache.pdfbox.cos.ICOSVisitor visitor)
            throws IOException
```
    Visitor pattern double dispatch method.
    
    指定者:
    
    accept 在类中 org.apache.pdfbox.cos.COSBase
    
    参数:
    
    visitor - The object to notify when visiting this object.
    
    抛出:
    
    IOException - If an error occurs while visiting this object.
  - toFloatArray
```
public float[] toFloatArray()
```
    This will take an COSArray of numbers and convert it to a float[].
    
    返回:
    
    This COSArray as an array of float numbers.
  - setFloatArray
```
public void setFloatArray(float[] value)
```
    Clear the current contents of the COSArray and set it with the float[].
    
    参数:
    
    value - The new value of the float array.
  - toList
```
public List<? extends org.apache.pdfbox.cos.COSBase> toList()
```
    Return contents of COSArray as a Java List.
    
    返回:
    
    the COSArray as List
  - toCOSNameStringList
```
public List<String> toCOSNameStringList()
```
    This will return a list of names if the COSArray consists of COSNames only.
    
    返回:
    
    the list of names of the COSArray of COSNames
  - toCOSStringStringList
```
public List<String> toCOSStringStringList()
```
    This will return a list of names if the COSArray consists of COSStrings only.
    
    返回:
    
    the list of names of the COSArray of COSStrings
  - toCOSNumberFloatList
```
public List<Float> toCOSNumberFloatList()
```
    This will return a list of float values if the COSArray consists of COSNumbers only.
    
    返回:
    
    the list of float values of the COSArray of COSNumbers
  - toCOSNumberIntegerList
```
public List<Integer> toCOSNumberIntegerList()
```
    This will return a list of int values if the COSArray consists of COSNumbers only.
    
    返回:
    
    the list of int values of the COSArray of COSNumbers
  - ofCOSIntegers
```
public static COSArray ofCOSIntegers(List<Integer> integer)
```
    This will take a list of integer objects and return a COSArray of COSInteger objects.
    
    参数:
    
    integer - A list of integers
    
    返回:
    
    An array of COSInteger objects
  - ofCOSNames
```
public static COSArray ofCOSNames(List<String> strings)
```
    This will take a list of string objects and return a COSArray of COSName objects.
    
    参数:
    
    strings - A list of strings
    
    返回:
    
    An array of COSName objects
  - ofCOSStrings
```
public static COSArray ofCOSStrings(List<String> strings)
```
    This will take a list of string objects and return a COSArray of COSName objects.
    
    参数:
    
    strings - A list of strings
    
    返回:
    
    An array of COSName objects
  - getUpdateState
```
public org.apache.pdfbox.cos.COSUpdateState getUpdateState()
```
    Returns the current COSUpdateState of this COSArray.
    
    指定者:
    
    getUpdateState 在接口中 org.apache.pdfbox.cos.COSUpdateInfo
    
    返回:
    
    The current COSUpdateState of this COSArray.
    
    另请参阅:
    
    COSUpdateState
  - getIndirectObjectKeys
```
public void getIndirectObjectKeys(List<org.apache.pdfbox.cos.COSObjectKey> indirectObjects)
```
    Collects all indirect objects numbers within this COSArray and all included dictionaries. It is used to avoid mixed up object numbers when importing an existing page to another pdf.
    Expert use only. You might run into an endless recursion if choosing a wrong starting point.
    
    参数:
    
    indirectObjects - a list of already found indirect objects.

类 COSArray

构造器概要

方法概要

从类继承的方法 org.apache.pdfbox.cos.COSBase

从类继承的方法 java.lang.Object

从接口继承的方法 java.lang.Iterable

从接口继承的方法 org.apache.pdfbox.cos.COSUpdateInfo

从接口继承的方法 org.apache.pdfbox.pdmodel.common.COSObjectable

构造器详细资料

COSArray

COSArray

方法详细资料

add

add

add

clear

removeAll

retainAll

addAll

addAll

addAll

set

set

set

getObject

get

getInt

getInt

setInt

setName

getName

getName

setString

getString

getString

size

remove

remove

removeObject

toString

iterator

indexOf

indexOfObject

growToSize

growToSize

accept

toFloatArray

setFloatArray

toList

toCOSNameStringList

toCOSStringStringList

toCOSNumberFloatList

toCOSNumberIntegerList

ofCOSIntegers

ofCOSNames

ofCOSStrings

getUpdateState

getIndirectObjectKeys