org.apache.sshd.common

Class Property.Validating<T>

java.lang.Object

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

All Implemented Interfaces:

NamedResource, Property<T>

Enclosing interface:

Property<T>

public static class Property.Validating<T>
extends 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 Enum<T>>, Property.IntegerProperty, Property.LongProperty, Property.ObjectProperty, Property.StringProperty, Property.Validating<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Property<T>	delegate
protected Consumer<? super T>	validator

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

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Constructor Summary

Constructors

Constructor and Description
Validating(Property<T> delegate, Consumer<? super T> validator)

Method Summary

Modifier and Type	Method and Description
Optional<T>	get(PropertyResolver resolver)
Optional<T>	getDefault()
String	getName()
T	getOrCustomDefault(PropertyResolver resolver, T defaultValue)
T	getRequiredDefault()
Class<T>	getType()
void	remove(PropertyResolver resolver)
void	set(PropertyResolver resolver, T value)

Methods inherited from class java.lang.Object

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

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

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

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

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

Field Detail

delegate

protected final Property<T> delegate

validator

protected final Consumer<? super T> validator

Constructor Detail

Validating

public Validating(Property<T> delegate,
                  Consumer<? super T> validator)

Method Detail

getName

public String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

getType

public Class<T> getType()

Specified by:

getType in interface Property<T>

Returns:

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

getDefault

public Optional<T> getDefault()

Specified by:

getDefault in interface Property<T>

Returns:

The Optional pre-defined default value

getRequiredDefault

public T getRequiredDefault()

Specified by:

getRequiredDefault in interface Property<T>

get

public 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

remove

public void remove(PropertyResolver resolver)

Specified by:

remove in interface Property<T>

Parameters:

resolver - The PropertyResolver to remove the property from