com.alee.utils.swing

Class NullableClientProperty<V extends Serializable>

java.lang.Object

com.alee.utils.swing.NullableClientProperty<V>

Type Parameters:

V - value type

All Implemented Interfaces:

Serializable

public final class NullableClientProperty<V extends Serializable>
extends Object
implements Serializable

Utility class providing easy access to a single client property of JComponent. It is used to decorate JComponent.getClientProperty(Object) and JComponent.putClientProperty(Object, Object) methods. It also contains a null-able default value that will be returned when JComponent doesn't have property defined.

Author:

Mikle Garin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NullableClientProperty(String key, V defaultValue) Constructs new NullableClientProperty.

Method Summary

Modifier and Type	Method and Description
V	defaultValue() Returns NullableClientProperty default value.
V	get(JComponent component) Returns NullableClientProperty value for the specified JComponent.
String	key() Returns NullableClientProperty key.
V	reset(JComponent component) Resets NullableClientProperty value in the specified JComponent to null.
V	set(JComponent component, V value) Updates NullableClientProperty value in the specified JComponent.

Methods inherited from class java.lang.Object

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

Constructor Detail

NullableClientProperty

public NullableClientProperty(@NotNull
                              String key,
                              @Nullable
                              V defaultValue)

Constructs new NullableClientProperty.

Parameters:

key - NullableClientProperty key

defaultValue - NullableClientProperty default value

Method Detail

key

@NotNull
public String key()

Returns NullableClientProperty key.

Returns:

NullableClientProperty key

defaultValue

@Nullable
public V defaultValue()

Returns NullableClientProperty default value.

Returns:

NullableClientProperty default value

get

@Nullable
public V get(@NotNull
                       JComponent component)

Returns NullableClientProperty value for the specified JComponent.

Parameters:

component - JComponent to retrieve value for

Returns:

NullableClientProperty value for the specified JComponent

set

@Nullable
public V set(@NotNull
                       JComponent component,
                       @Nullable
                       V value)

Updates NullableClientProperty value in the specified JComponent.

Parameters:

component - JComponent to update value for

value - new value

Returns:

old NullableClientProperty value for the specified JComponent

reset

@Nullable
public V reset(@NotNull
                         JComponent component)

Resets NullableClientProperty value in the specified JComponent to null.

Parameters:

component - JComponent to reset value for

Returns:

old NullableClientProperty value for the specified JComponent