com.alee.utils.swing

Class WeakComponentData<C extends JComponent,D>

java.lang.Object

com.alee.utils.swing.WeakComponentData<C,D>

Type Parameters:

C - JComponent type

D - data type

Direct Known Subclasses:

WeakComponentDataList

public class WeakComponentData<C extends JComponent,D>
extends Object

This is a special wrapper for any JComponent-related data that have to be stored using weak references. The only hard reference to that data will be stored within JComponent itself, so the data will only get removed along with the JComponent itself or if removal calls are made explicitly. This class also keeps a Set of weak references to all components that have data of this kind stored within them. It can be used to iterate through all of those components whenever it is needed. Note that stored data cannot be null at any point as null is considered to be no data case.

Author:

Mikle Garin

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<C>	components Set of JComponents that have data of this kind stored within them.
protected String	key Key used to place data within JComponent using JComponent.putClientProperty(Object, Object) method.

Constructor Summary

Constructors

Constructor and Description
WeakComponentData(String key, int initialCapacity) Constructs new WeakComponentData.

Method Summary

Modifier and Type	Method and Description
boolean	allMatch(BiPredicate<C,D> predicate) Returns whether or not all of the stored data pieces are accepted by specified BiPredicate.
boolean	anyMatch(BiPredicate<C,D> predicate) Returns whether or not at least one of the stored data pieces is accepted by specified BiPredicate.
D	clear(C component) Clears data stored in the JComponent.
D	clear(C component, BiConsumer<C,D> removedDataConsumer) Clears data stored in the JComponent.
Set<C>	components() Returns Set of JComponents that have data of this kind stored within them.
boolean	contains(C component) Returns whether or not specified JComponent has data of this kind stored within.
void	forEach(BiConsumer<C,D> consumer) Provides each stored data piece into specified BiConsumer.
D	get(C component) Returns data stored in the JComponent.
D	get(C component, Function<C,D> defaultData) Returns data stored in the JComponent.
D	modify(C component, BiFunction<C,D,D> modifiedData, Function<C,D> defaultData) Modifies data stored in the JComponent using specified BiFunction and returns it.
boolean	noneMatch(BiPredicate<C,D> predicate) Returns whether or not none of the stored data pieces are accepted by specified BiPredicate.
D	set(C component, D data) Stores data in the specified JComponent.
D	set(C component, D data, BiConsumer<C,D> oldDataConsumer) Stores data in the specified JComponent.
int	size() Returns size of the Set of JComponents that have data of this kind stored within them.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

key

@NotNull
protected final String key

Key used to place data within JComponent using JComponent.putClientProperty(Object, Object) method. Make sure that every manager uses its own unique keys for registering different data to avoid unwanted overwrites.

components

@NotNull
protected final Set<C extends JComponent> components

Set of JComponents that have data of this kind stored within them. WeakHashSet implementation is used to avoid hard component references that could cause memory leaks.

Constructor Detail

WeakComponentData

public WeakComponentData(@NotNull
                         String key,
                         int initialCapacity)

Constructs new WeakComponentData.

Parameters:

key - key used to place data within JComponent

initialCapacity - initial capacity for the Set of JComponents

Method Detail

components

@NotNull
public Set<C> components()

Returns Set of JComponents that have data of this kind stored within them.

Returns:

Set of JComponents that have data of this kind stored within them

size

public int size()

Returns size of the Set of JComponents that have data of this kind stored within them.

Returns:

size of the Set of JComponents that have data of this kind stored within them

contains

public boolean contains(@NotNull
                        C component)

Returns whether or not specified JComponent has data of this kind stored within.

Parameters:

component - JComponent to check data in

Returns:

true if specified JComponent has data of this kind stored within, false otherwise

get

@Nullable
public D get(@NotNull
                       C component)

Returns data stored in the JComponent. Could return null if no data can be found.

Parameters:

component - JComponent to retrieve data from

Returns:

data stored in the JComponent

get

@NotNull
public D get(@NotNull
                      C component,
                      @NotNull
                      Function<C,D> defaultData)

Returns data stored in the JComponent. If no data can be found it will be created using mapping Function, stored within JComponent and returned as result.

Parameters:

component - JComponent to retrieve data from

defaultData - Function that creates default data in case it is missing

Returns:

data stored in the JComponent

modify

@NotNull
public D modify(@NotNull
                         C component,
                         @NotNull
                         BiFunction<C,D,D> modifiedData,
                         @NotNull
                         Function<C,D> defaultData)

Modifies data stored in the JComponent using specified BiFunction and returns it. If no data can be found it will be created using mapping Function, stored within JComponent and returned as result.

Parameters:

component - JComponent to retrieve and modify data from

modifiedData - BiFunction that modifies data in case it exists

defaultData - Function that creates default data in case it is missing

Returns:

modified data from the JComponent

set

@Nullable
public D set(@NotNull
                       C component,
                       @Nullable
                       D data)

Stores data in the specified JComponent. Providing null data would result in calling clear(JComponent) method instead.

Parameters:

component - JComponent to store data in

data - data to store

Returns:

old data

set

@Nullable
public D set(@NotNull
                       C component,
                       @Nullable
                       D data,
                       @NotNull
                       BiConsumer<C,D> oldDataConsumer)

Stores data in the specified JComponent. Providing null data would result in calling clear(JComponent, BiConsumer) method instead.

Parameters:

component - JComponent to store data in

data - data to store

oldDataConsumer - BiConsumer for previous data

Returns:

old data

clear

@Nullable
public D clear(@NotNull
                         C component)

Clears data stored in the JComponent.

Parameters:

component - JComponent to clear stored data for

Returns:

old data

clear

@Nullable
public D clear(@NotNull
                         C component,
                         @NotNull
                         BiConsumer<C,D> removedDataConsumer)

Clears data stored in the JComponent.

Parameters:

component - JComponent to clear stored data for

removedDataConsumer - BiConsumer for removed data

Returns:

old data

forEach

public void forEach(@NotNull
                    BiConsumer<C,D> consumer)

Provides each stored data piece into specified BiConsumer.

Parameters:

consumer - BiConsumer for JComponent and data

anyMatch

public boolean anyMatch(@NotNull
                        BiPredicate<C,D> predicate)

Returns whether or not at least one of the stored data pieces is accepted by specified BiPredicate.

Parameters:

predicate - BiPredicate for JComponent and data

Returns:

true if at least one of the stored data pieces is accepted by specified BiPredicate, false otherwise

allMatch

public boolean allMatch(@NotNull
                        BiPredicate<C,D> predicate)

Returns whether or not all of the stored data pieces are accepted by specified BiPredicate.

Parameters:

predicate - BiPredicate for JComponent and data

Returns:

true if all of the stored data pieces are accepted by specified BiPredicate, false otherwise

noneMatch

public boolean noneMatch(@NotNull
                         BiPredicate<C,D> predicate)

Returns whether or not none of the stored data pieces are accepted by specified BiPredicate.

Parameters:

predicate - BiPredicate for JComponent and data

Returns:

true if none of the stored data pieces are accepted by specified BiPredicate, false otherwise