Top Description Inners Fields Methods
org.apache.sshd.common

public Interface Property<T>

extends NamedResource
Known Direct Implementers
org.apache.sshd.common.Property.BaseProperty, org.apache.sshd.common.Property.Validating
Type Parameters
<T>
The generic property type
Imports
java.nio.charset.Charset, java.time.Duration, java.util.Collection, .Collections, .EnumSet, .NoSuchElementException, .Objects, .Optional, java.util.function.Consumer, org.apache.sshd.common.util.ValidateUtils

Property definition.
Author
Apache MINA SSHD Project

Nested and Inner Type Summary

Modifier and TypeClass and Description
public abstract static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class
public static class

Field Summary

Inherited from org.apache.sshd.common.NamedResource:
BY_NAME_COMPARATORNAME_EXTRACTOR

Method Summary

Modifier and TypeMethod and Description
public static Property<Boolean>
bool(String name)

public static Property<Boolean>
bool(String name, boolean def)

public static Property<Charset>
public static Property<Charset>
charset(String name, Charset def)

public static Property<Duration>
public static Property<Duration>
public static Property<Duration>
duration(String name, Duration def, Duration min)

public static Property<Duration>
public static Property<Duration>
public static Property<Duration>
public static <T extends Enum<T>> Property<T>
enum_(String name, Class<T> type)

public static <T extends Enum<T>> Property<T>
enum_(String name, Class<T> type, T def)

public Optional<T>

Returns:

The Optional result - if resolver contains a value then the resolver's value, otherwise the pre-defined default
get
(PropertyResolver
The PropertyResolver to query for the property value.
resolver
)

public Optional<T>

Returns:

The Optional pre-defined default value
getDefault
()

public T

Returns:

The resolver's value or specified default if no specific value found in the resolver - regardless of whether there is a default value
getOrCustomDefault
(PropertyResolver
The PropertyResolver to query for the property value.
resolver
,
T
The default value to return if no specific value found in resolver
defaultValue
)

public default T

Returns:

The resolver's value or null if no specific value found in the resolver - regardless of whether there is a default value
getOrNull
(PropertyResolver
The PropertyResolver to query for the property value.
resolver
)

public default T

Returns:

The resolved value
getRequired
(PropertyResolver
The PropertyResolver to query for the property value.
resolver
)

public default T
public Class<T>

Returns:

Property type - Note: for primitive types the wrapper equivalent is returned
getType
()

public static Property<Integer>
public static Property<Integer>
integer(String name, int def)

public static Property<Long>
long_(String name)

public static Property<Long>
long_(String name, long def)

public static Property<Object>
object(String name)

public static Property<Object>
object(String name, Object def)

public default void
remove(PropertyResolver
The PropertyResolver to remove the property from
resolver
)

public void
set(PropertyResolver
The PropertyResolver to update with the property value.
resolver
,
T
The value to set
value
)

public static Property<String>
string(String name)

public static Property<String>
string(String name, String def)

public static <T> Property<T>
validating(Property<T> prop, Consumer<? super T> validator)

Inherited from org.apache.sshd.common.NamedResource:
findByNamefindFirstMatchByNamegetNamegetNameListgetNamesofNameremoveByNamesafeCompareByName