Top Fields Constructors Methods

org.apache.sshd.common.config

public final Enum TimeValueConfig

Class Inheritance

extends Enum<TimeValueConfig>

java.lang.Object
java.lang.Object
java.lang.Enum
org.apache.sshd.common.config.TimeValueConfig

Imports

java.util.Collections, .EnumMap, .EnumSet, .Map, .Set, java.util.concurrent.TimeUnit, org.apache.sshd.common.util.GenericUtils, .MapEntryUtils

Author: Apache MINA SSHD Project
See Also: Time formats for SSH configuration values

Field Summary

Modifier and Type	Field and Description
public static final TimeValueConfig	DAYS
private final char	hiChar
public static final TimeValueConfig	HOURS
private final long	interval
private final char	loChar
public static final TimeValueConfig	MINUTES
public static final TimeValueConfig	SECONDS
public static final Set<TimeValueConfig>	VALUES
public static final TimeValueConfig	WEEKS

Constructor Summary

Access	Constructor and Description
private	TimeValueConfig(char lo, char hi, long interval)

Method Summary

Modifier and Type	Method and Description
public static long	Returns: The specified duration in milliseconds durationOf(String A time specification s)
public static long	Returns: The total duration in milliseconds durationOf(Map<TimeValueConfig, ? extends Number> The `Map` specifying the count for each `TimeValueConfig` spec)
public static TimeValueConfig	fromValueChar(char ch)
public final long	getInterval()
public final char	getLowerCaseValue()
public final char	getUpperCaseValue()
public static Map<TimeValueConfig, Long>	Returns: A `Map` specifying for each time unit its count parse(String An input time specification containing possibly mixed numbers and units - e.g., `3h10m` to indicate 3 hours and 10 minutes s)
public static TimeValueConfig	valueOf(String name)
public static TimeValueConfig[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DAYS	back to summary
public static final TimeValueConfig DAYS

hiChar	back to summary
private final char hiChar

HOURS	back to summary
public static final TimeValueConfig HOURS

interval	back to summary
private final long interval

loChar	back to summary
private final char loChar

MINUTES	back to summary
public static final TimeValueConfig MINUTES

SECONDS	back to summary
public static final TimeValueConfig SECONDS

VALUES	back to summary
public static final Set<TimeValueConfig> VALUES

WEEKS	back to summary
public static final TimeValueConfig WEEKS

Constructor Detail

TimeValueConfig	back to summary
private TimeValueConfig(char lo, char hi, long interval)

Method Detail

durationOf	back to summary
public static long durationOf(String s) Parameters s:String A time specification Returns:long The specified duration in milliseconds See Also `parse(String)`, `durationOf(Map)`

durationOf	back to summary
public static long durationOf(Map<TimeValueConfig, ? extends Number> spec) throws IllegalArgumentException Parameters spec:Map<TimeValueConfig, ? extends Number> The `Map` specifying the count for each `TimeValueConfig` Returns:long The total duration in milliseconds Exceptions IllegalArgumentException: If negative count for a time unit

fromValueChar	back to summary
public static TimeValueConfig fromValueChar(char ch)

getInterval	back to summary
public final long getInterval()

getLowerCaseValue	back to summary
public final char getLowerCaseValue()

getUpperCaseValue	back to summary
public final char getUpperCaseValue()

parse back to summary

public static Map<TimeValueConfig, Long> parse(String s) throws IllegalArgumentException

Parameters

s:String: An input time specification containing possibly mixed numbers and units - e.g., 3h10m to indicate 3 hours and 10 minutes

Returns:Map<TimeValueConfig, Long>

A Map specifying for each time unit its count

Exceptions

IllegalArgumentException:: If bad format - e.g., unknown unit
NumberFormatException:: If bad numbers found - e.g., negative counts

valueOf	back to summary
public static TimeValueConfig valueOf(String name)

values	back to summary
public static TimeValueConfig[] values()