StateObjectCollection (Flink : Runtime 1.17.1 API)

java.lang.Object
- org.apache.flink.runtime.checkpoint.StateObjectCollection<T>

类型参数:

T - type of the contained state objects.

所有已实现的接口:

Serializable, Iterable<T>, Collection<T>, StateObject
```
public class StateObjectCollection<T extends StateObject>
extends Object
implements Collection<T>, StateObject
```
This class represents a generic collection for StateObjects. Being a state object itself, it delegates discardState() to all contained state objects and computes getStateSize() as sum of the state sizes of all contained objects.

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明
`StateObjectCollection()` Creates a new StateObjectCollection that is backed by an `ArrayList`.
`StateObjectCollection(Collection<T> stateObjects)` Creates a new StateObjectCollection wraps the given collection and delegates to it.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`add(T t)`
`boolean`	`addAll(Collection<? extends T> c)`
`List<T>`	`asList()`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`void`	`discardState()` Discards the state referred to and solemnly owned by this handle, to free up resources in the persistent storage.
`static <T extends StateObject> StateObjectCollection<T>`	`empty()`
`static <T extends StateObject> StateObjectCollection<T>`	`emptyIfNull(StateObjectCollection<T> collection)`
`boolean`	`equals(Object o)`
`long`	`getCheckpointedSize()`
`long`	`getStateSize()` Returns the size of the state in bytes.
`int`	`hashCode()`
`boolean`	`hasState()` Returns true if this contains at least one `StateObject`.
`boolean`	`isEmpty()`
`Iterator<T>`	`iterator()`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`removeIf(java.util.function.Predicate<? super T> filter)`
`boolean`	`retainAll(Collection<?> c)`
`static <T extends StateObject> StateObjectCollection<T>`	`singleton(T stateObject)`
`static <T extends StateObject> StateObjectCollection<T>`	`singletonOrEmpty(T stateObject)`
`int`	`size()`
`Object[]`	`toArray()`
`<T1> T1[]`	`toArray(T1[] a)`
`String`	`toString()`

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

从接口继承的方法 java.util.Collection
parallelStream, spliterator, stream

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

- 构造器详细资料
  - StateObjectCollection
```
public StateObjectCollection()
```
    Creates a new StateObjectCollection that is backed by an ArrayList.
  - StateObjectCollection
```
public StateObjectCollection(Collection<T> stateObjects)
```
    Creates a new StateObjectCollection wraps the given collection and delegates to it.
    
    参数:
    
    stateObjects - collection of state objects to wrap.
- 方法详细资料
  - size
```
public int size()
```
    指定者:
    
    size 在接口中 Collection<T extends StateObject>
  - isEmpty
```
public boolean isEmpty()
```
    指定者:
    
    isEmpty 在接口中 Collection<T extends StateObject>
  - contains
```
public boolean contains(Object o)
```
    指定者:
    
    contains 在接口中 Collection<T extends StateObject>
  - iterator
```
public Iterator<T> iterator()
```
    指定者:
    
    iterator 在接口中 Iterable<T extends StateObject>
    
    指定者:
    
    iterator 在接口中 Collection<T extends StateObject>
  - toArray
```
public Object[] toArray()
```
    指定者:
    
    toArray 在接口中 Collection<T extends StateObject>
  - toArray
```
public <T1> T1[] toArray(T1[] a)
```
    指定者:
    
    toArray 在接口中 Collection<T extends StateObject>
  - add
```
public boolean add(T t)
```
    指定者:
    
    add 在接口中 Collection<T extends StateObject>
  - remove
```
public boolean remove(Object o)
```
    指定者:
    
    remove 在接口中 Collection<T extends StateObject>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    指定者:
    
    containsAll 在接口中 Collection<T extends StateObject>
  - addAll
```
public boolean addAll(Collection<? extends T> c)
```
    指定者:
    
    addAll 在接口中 Collection<T extends StateObject>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    指定者:
    
    removeAll 在接口中 Collection<T extends StateObject>
  - removeIf
```
public boolean removeIf(java.util.function.Predicate<? super T> filter)
```
    指定者:
    
    removeIf 在接口中 Collection<T extends StateObject>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    指定者:
    
    retainAll 在接口中 Collection<T extends StateObject>
  - clear
```
public void clear()
```
    指定者:
    
    clear 在接口中 Collection<T extends StateObject>
  - discardState
```
public void discardState()
                  throws Exception
```
    从接口复制的说明: StateObject
    
    Discards the state referred to and solemnly owned by this handle, to free up resources in the persistent storage. This method is called when the state represented by this object will not be used any more.
    
    指定者:
    
    discardState 在接口中 StateObject
    
    抛出:
    
    Exception
  - getStateSize
```
public long getStateSize()
```
    从接口复制的说明: StateObject
    
    Returns the size of the state in bytes. If the size is not known, this method should return 0.
    The values produced by this method are only used for informational purposes and for metrics/monitoring. If this method returns wrong values, the checkpoints and recovery will still behave correctly. However, efficiency may be impacted (wrong space pre-allocation) and functionality that depends on metrics (like monitoring) will be impacted.
    Note for implementors: This method should not perform any I/O operations while obtaining the state size (hence it does not declare throwing an IOException). Instead, the state size should be stored in the state object, or should be computable from the state stored in this object. The reason is that this method is called frequently by several parts of the checkpointing and issuing I/O requests from this method accumulates a heavy I/O load on the storage system at higher scale.
    
    指定者:
    
    getStateSize 在接口中 StateObject
    
    返回:
    
    Size of the state in bytes.
  - getCheckpointedSize
```
public long getCheckpointedSize()
```
  - hasState
```
public boolean hasState()
```
    Returns true if this contains at least one StateObject.
  - equals
```
public boolean equals(Object o)
```
    指定者:
    
    equals 在接口中 Collection<T extends StateObject>
    
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    指定者:
    
    hashCode 在接口中 Collection<T extends StateObject>
    
    覆盖:
    
    hashCode 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - asList
```
public List<T> asList()
```
  - empty
```
public static <T extends StateObject> StateObjectCollection<T> empty()
```
  - emptyIfNull
```
public static <T extends StateObject> StateObjectCollection<T> emptyIfNull(@Nullable
                                                                           StateObjectCollection<T> collection)
```
  - singleton
```
public static <T extends StateObject> StateObjectCollection<T> singleton(T stateObject)
```
  - singletonOrEmpty
```
public static <T extends StateObject> StateObjectCollection<T> singletonOrEmpty(@Nullable
                                                                                T stateObject)
```

类 StateObjectCollection<T extends StateObject>

构造器概要

方法概要

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

从接口继承的方法 java.util.Collection

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

构造器详细资料

StateObjectCollection

StateObjectCollection

方法详细资料

size

isEmpty

contains

iterator

toArray

toArray

add

remove

containsAll

addAll

removeAll

removeIf

retainAll

clear

discardState

getStateSize

getCheckpointedSize

hasState

equals

hashCode

toString

asList

empty

emptyIfNull

singleton

singletonOrEmpty