org.apache.sshd.common

Class Property.BaseProperty<T>

java.lang.Object

org.apache.sshd.common.Property.BaseProperty<T>

All Implemented Interfaces:

NamedResource, Property<T>

Direct Known Subclasses:

Property.BooleanProperty, Property.CharsetProperty, Property.DurationProperty, Property.EnumProperty, Property.IntegerProperty, Property.LongProperty, Property.ObjectProperty, Property.StringProperty

Enclosing interface:

Property<T>

public abstract static class Property.BaseProperty<T>
extends java.lang.Object
implements Property<T>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.common.Property

Property.BaseProperty<T>, Property.BooleanProperty, Property.CharsetProperty, Property.DurationInSecondsProperty, Property.DurationProperty, Property.EnumProperty<T extends java.lang.Enum<T>>, Property.IntegerProperty, Property.LongProperty, Property.ObjectProperty, Property.StringProperty, Property.Validating<T>

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Optional<T>	defaultValue
private java.lang.String	name
private java.lang.Class<T>	type

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseProperty(java.lang.String name, java.lang.Class<T> type)
protected	BaseProperty(java.lang.String name, java.lang.Class<T> type, T defaultValue)

Method Summary

Modifier and Type	Method and Description
protected abstract T	fromStorage(java.lang.Object value)
java.util.Optional<T>	get(PropertyResolver resolver)
java.util.Optional<T>	getDefault()
java.lang.String	getName()
T	getOrCustomDefault(PropertyResolver resolver, T defaultValue)
java.lang.Class<T>	getType()
void	set(PropertyResolver resolver, T value)
protected java.lang.Object	toStorage(T value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.Property

bool, bool, charset, charset, duration, duration, duration, durationSec, durationSec, durationSec, enum_, enum_, getOrNull, getRequired, getRequiredDefault, integer, integer, long_, long_, object, object, remove, string, string, validating

Methods inherited from interface org.apache.sshd.common.NamedResource

findByName, findFirstMatchByName, getNameList, getNames, ofName, removeByName, safeCompareByName

Field Detail

name

private final java.lang.String name

type

private final java.lang.Class<T> type

defaultValue

private final java.util.Optional<T> defaultValue

Constructor Detail

BaseProperty

protected BaseProperty(java.lang.String name,
                       java.lang.Class<T> type)

BaseProperty

protected BaseProperty(java.lang.String name,
                       java.lang.Class<T> type,
                       T defaultValue)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

getType

public java.lang.Class<T> getType()

Specified by:

getType in interface Property<T>

Returns:

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

getDefault

public java.util.Optional<T> getDefault()

Specified by:

getDefault in interface Property<T>

Returns:

The Optional pre-defined default value

get

public java.util.Optional<T> get(PropertyResolver resolver)

Specified by:

get in interface Property<T>

Parameters:

resolver - The PropertyResolver to query for the property value.

Returns:

The Optional result - if resolver contains a value then the resolver's value, otherwise the pre-defined default

getOrCustomDefault

public T getOrCustomDefault(PropertyResolver resolver,
                            T defaultValue)

Specified by:

getOrCustomDefault in interface Property<T>

Parameters:

resolver - The PropertyResolver to query for the property value.

defaultValue - The default value to return if no specific value found in resolver

Returns:

The resolver's value or specified default if no specific value found in the resolver - regardless of whether there is a default value

set

public void set(PropertyResolver resolver,
                T value)

Specified by:

set in interface Property<T>

Parameters:

resolver - The PropertyResolver to update with the property value.

value - The value to set

toStorage

protected java.lang.Object toStorage(T value)

fromStorage

protected abstract T fromStorage(java.lang.Object value)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object