org.openide.nodes

Class PropertySupport<T>

java.lang.Object

java.beans.FeatureDescriptor

org.openide.nodes.Node.Property<T>

org.openide.nodes.PropertySupport<T>

Type Parameters:

T - the type of the represented property.

Direct Known Subclasses:

PropertySupport.Name, PropertySupport.ReadOnly, PropertySupport.ReadWrite, PropertySupport.WriteOnly

public abstract class PropertySupport<T>
extends Node.Property<T>

Support class for Node.Property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertySupport.Name Support for the name property of a node.
static class	PropertySupport.ReadOnly<T> A simple read-only property.
static class	PropertySupport.ReadWrite<T> A simple read/write property.
static class	PropertySupport.Reflection<T> Support for properties from Java Reflection.
static class	PropertySupport.WriteOnly<T> A simple write-only property.

Constructor Summary

Constructors

Constructor and Description
PropertySupport(String name, Class<T> type, String displayName, String shortDescription, boolean canR, boolean canW) Constructs a new support.

Method Summary

Modifier and Type	Method and Description
boolean	canRead() Test whether the property is readable.
boolean	canWrite() Test whether the property is writable.
static <T> PropertySupport<T>	readOnly(String name, Class<T> valueType, java.util.function.Supplier<T> supplier) Creates a read-only "virtual" property where getter is backed by the provided Supplier functional interface.
static <T> PropertySupport<T>	readWrite(String name, Class<T> valueType, java.util.function.Supplier<T> supplier, java.util.function.Consumer<T> consumer) Creates a "virtual" property where getter and setter are backed by the provided Supplier and Consumer functional interfaces.
PropertySupport<T>	withDisplayName(String displayName) Fluent wrapper method for FeatureDescriptor.setDisplayName(java.lang.String).
PropertySupport<T>	withShortDescription(String shortDescription) Fluent wrapper method for FeatureDescriptor.setShortDescription(java.lang.String).
static <T> PropertySupport<T>	writeOnly(String name, Class<T> valueType, java.util.function.Consumer<T> consumer) Creates a write-only "virtual" property where setter is backed by the provided Consumer functional interface.

Methods inherited from class org.openide.nodes.Node.Property

equals, getHtmlDisplayName, getPropertyEditor, getValue, getValueType, hashCode, isDefaultValue, restoreDefaultValue, setValue, supportsDefaultValue

Methods inherited from class java.beans.FeatureDescriptor

attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertySupport

public PropertySupport(String name,
                       Class<T> type,
                       String displayName,
                       String shortDescription,
                       boolean canR,
                       boolean canW)

Constructs a new support.

Parameters:

name - the name of the property

type - the class type of the property

displayName - the display name of the property

canR - whether the property is readable

canW - whether the property is writable

Method Detail

canRead

public boolean canRead()

Description copied from class: Node.Property

Test whether the property is readable.

Specified by:

canRead in class Node.Property<T>

Returns:

true if it is

canWrite

public boolean canWrite()

Description copied from class: Node.Property

Test whether the property is writable.

Specified by:

canWrite in class Node.Property<T>

Returns:

true if the read of the value is supported

withDisplayName

public final PropertySupport<T> withDisplayName(String displayName)

Fluent wrapper method for FeatureDescriptor.setDisplayName(java.lang.String).

Parameters:

displayName - the display name to set.

Returns:

this instance

Since:

7.62

withShortDescription

public final PropertySupport<T> withShortDescription(String shortDescription)

Fluent wrapper method for FeatureDescriptor.setShortDescription(java.lang.String).

Parameters:

shortDescription - short description

Returns:

this instance

Since:

7.62

readWrite

public static <T> PropertySupport<T> readWrite(String name,
                                               Class<T> valueType,
                                               java.util.function.Supplier<T> supplier,
                                               java.util.function.Consumer<T> consumer)

Creates a "virtual" property where getter and setter are backed by the provided Supplier and Consumer functional interfaces.

Type Parameters:

T - the type of the property

Parameters:

name - the name of the property

valueType - the type of the property

supplier - the getter functional interface, can be null for write-only properties.

consumer - the setter functional interface, can be null for read-only properties.

Returns:

a PropertySupport instance where getter and setter are backed by the provided functional interfaces.

Since:

7.62

readOnly

public static <T> PropertySupport<T> readOnly(String name,
                                              Class<T> valueType,
                                              java.util.function.Supplier<T> supplier)

Creates a read-only "virtual" property where getter is backed by the provided Supplier functional interface.

Type Parameters:

T - the type of the property

Parameters:

name - the name of the property

valueType - the type of the property

supplier - the getter functional interface.

Returns:

a read-only PropertySupport instance where getter is backed by the provided functional interface.

Since:

7.62

writeOnly

public static <T> PropertySupport<T> writeOnly(String name,
                                               Class<T> valueType,
                                               java.util.function.Consumer<T> consumer)

Creates a write-only "virtual" property where setter is backed by the provided Consumer functional interface.

Type Parameters:

T - the type of the property

Parameters:

name - the name of the property

valueType - the type of the property

consumer - the setter functional interface.

Returns:

a write-only PropertySupport instance where setter is backed by the provided functional interface.

Since:

7.62