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
Property definition.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
static class
static class
static class
static class
static class
Property.EnumProperty<T extends Enum<T>>
static class
static class
static class
static class
static class
-
Field Summary
Fields inherited from interface org.apache.sshd.common.NamedResource
BY_NAME_COMPARATOR, NAME_EXTRACTOR
-
Method Summary
Modifier and TypeMethodDescriptiondurationSec
(String name) durationSec
(String name, Duration def) get
(PropertyResolver resolver) getOrCustomDefault
(PropertyResolver resolver, T defaultValue) default T
getOrNull
(PropertyResolver resolver) default T
getRequired
(PropertyResolver resolver) default T
getType()
default void
remove
(PropertyResolver resolver) void
set
(PropertyResolver resolver, T value) static <T> Property<T>
validating
(Property<T> prop, Consumer<? super T> validator) Methods inherited from interface org.apache.sshd.common.NamedResource
getName
-
Method Details
-
string
-
string
-
bool
-
bool
-
integer
-
integer
-
long_
-
long_
-
enum_
-
enum_
-
duration
-
duration
-
durationSec
-
durationSec
-
charset
-
charset
-
object
-
object
-
validating
-
getType
- Returns:
- Property type - Note: for primitive types the wrapper equivalent is returned
-
getDefault
- Returns:
- The
Optional
pre-defined default value
-
getRequiredDefault
-
get
- 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
- Parameters:
resolver
- ThePropertyResolver
to query for the property value.- Returns:
- The resolved value
- Throws:
NoSuchElementException
- if resolver contains no value and nogetDefault()
defined
-
getOrNull
- 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
- 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
- Parameters:
resolver
- ThePropertyResolver
to update with the property value.value
- The value to set
-
remove
- Parameters:
resolver
- ThePropertyResolver
to remove the property from
-