Package org.apache.sshd.common
Interface Property<T>
-
- Type Parameters:
T
- The generic property type
- All Superinterfaces:
NamedResource
- All Known Implementing Classes:
Property.BaseProperty
,Property.BooleanProperty
,Property.CharsetProperty
,Property.DurationInSecondsProperty
,Property.DurationProperty
,Property.EnumProperty
,Property.IntegerProperty
,Property.LongProperty
,Property.ObjectProperty
,Property.StringProperty
,Property.Validating
public interface Property<T> extends NamedResource
Property definition.- Author:
- Apache MINA SSHD Project
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Property.BaseProperty<T>
static class
Property.BooleanProperty
static class
Property.CharsetProperty
static class
Property.DurationInSecondsProperty
static class
Property.DurationProperty
static class
Property.EnumProperty<T extends Enum<T>>
static class
Property.IntegerProperty
static class
Property.LongProperty
static class
Property.ObjectProperty
static class
Property.StringProperty
static class
Property.Validating<T>
-
Field Summary
-
Fields inherited from interface org.apache.sshd.common.NamedResource
BY_NAME_COMPARATOR, NAME_EXTRACTOR
-
-
Method Summary
-
Methods inherited from interface org.apache.sshd.common.NamedResource
getName
-
-
-
-
Method Detail
-
getType
Class<T> getType()
- Returns:
- Property type - Note: for primitive types the wrapper equivalent is returned
-
getRequiredDefault
default T getRequiredDefault()
-
get
Optional<T> get(PropertyResolver resolver)
- Parameters:
resolver
- ThePropertyResolver
to query for the property value.- Returns:
- The
Optional
result - if resolver contains a value then the resolver's value, otherwise the pre-defineddefault
-
getRequired
default T getRequired(PropertyResolver resolver)
- Parameters:
resolver
- ThePropertyResolver
to query for the property value.- Returns:
- The resolved value
- Throws:
NoSuchElementException
- if resolver contains no value and nogetDefault()
defined
-
getOrNull
default T getOrNull(PropertyResolver resolver)
- Parameters:
resolver
- ThePropertyResolver
to query for the property value.- Returns:
- The resolver's value or
null
if no specific value found in the resolver - regardless of whether there is a default value
-
getOrCustomDefault
T getOrCustomDefault(PropertyResolver resolver, T defaultValue)
- Parameters:
resolver
- ThePropertyResolver
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
void set(PropertyResolver resolver, T value)
- Parameters:
resolver
- ThePropertyResolver
to update with the property value.value
- The value to set
-
remove
default void remove(PropertyResolver resolver)
- Parameters:
resolver
- ThePropertyResolver
to remove the property from
-
-