Class ArgTools
- java.lang.Object
-
- de.intarsys.tools.functor.ArgTools
-
public class ArgTools extends java.lang.Object
Tool class to ease handling of arguments.
-
-
Constructor Summary
Constructors Constructor Description ArgTools()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description protected static ILocator
createLocator(java.lang.Object optionValue, ILocator defaultValue, ILocatorFactory factory)
static IArgs
getArgs(IArgs args, java.lang.String name, IArgs defaultValue)
The argument value atname
as anIArgs
instance.static boolean
getBool(IArgs args, java.lang.String name, boolean defaultValue)
The argument value atname
as a boolean.static byte
getByte(IArgs args, java.lang.String name, byte defaultValue)
The argument value atname
as a byte.static char
getChar(IArgs args, java.lang.String name, char defaultValue)
The argument value atname
as a char.static char[]
getCharArray(IArgs args, java.lang.String name, char[] defaultValue)
The argument value atname
as a char[].static java.lang.Class
getClass(IArgs args, java.lang.String name, java.lang.Class defaultValue)
The argument value atname
as aClass
.static java.util.Date
getDate(IArgs args, java.lang.String name, java.util.Date defaultValue)
The argument value atname
as aDate
.static <T extends EnumItem>
TgetEnumItem(IArgs args, EnumMeta<T> meta, java.lang.String name)
The argument value atname
as aEnumItem
.static <T extends EnumItem>
TgetEnumItem(IArgs args, EnumMeta<T> meta, java.lang.String name, java.lang.String defaultValue)
The argument value atname
as aEnumItem
.static java.io.File
getFile(IArgs args, java.lang.String name, java.io.File defaultValue)
The argument value atname
as aFile
.static float
getFloat(IArgs args, java.lang.String name, float defaultValue)
The argument value atname
as a float.static int
getInt(IArgs args, java.lang.String name, int defaultValue)
The argument value atname
as a int.static ILocator
getLocator(IArgs args, java.lang.String name, ILocator defaultValue, ILocatorFactory factory)
The argument value atname
as aILocator
.static java.util.List<ILocator>
getLocators(IArgs args, java.lang.String name, ILocatorFactory factory)
The argument value atname
as a List. static java.util.Map
getMap(IArgs args, java.lang.String name, java.util.Map defaultValue)
The argument value atname
as aMap
.static java.lang.Object
getObject(IArgs args, java.lang.String name, java.lang.Object defaultValue)
The argument value atname
as aObject
.static java.awt.geom.Point2D
getPoint(IArgs args, java.lang.String name, java.awt.geom.Point2D defaultValue)
The argument value atname
as aPoint2D
.static java.lang.String
getString(IArgs args, java.lang.String name, java.lang.String defaultValue)
The argument value atname
as aString
.static java.lang.String
prefix(java.lang.String prefix, java.lang.String name)
Create a new argument name fromname
by prefixing withprefix
.static IArgs
toArgs(java.lang.Object value)
Cast or convertvalue
to anIArgs
.static java.util.List
toList(IArgs args)
Convert theargs
to aList
.static java.util.Map
toMap(IArgs args)
Convert theargs
to aMap
.static java.lang.String
toString(IArgs args, java.lang.String prefix)
Create a printableString
forargs
.protected static void
toStringArgs(java.lang.String prefix, java.lang.StringBuilder sb, java.lang.String name, IArgs value)
protected static void
toStringPlain(java.lang.String prefix, java.lang.StringBuilder sb, java.lang.String name, java.lang.Object value)
-
-
-
Field Detail
-
toString
public static final IFunctor toString
-
-
Method Detail
-
createLocator
protected static ILocator createLocator(java.lang.Object optionValue, ILocator defaultValue, ILocatorFactory factory)
-
getArgs
public static IArgs getArgs(IArgs args, java.lang.String name, IArgs defaultValue)
The argument value atname
as anIArgs
instance. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,IArgs
,String
,Map
andList
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as anIArgs
instance.
-
getBool
public static boolean getBool(IArgs args, java.lang.String name, boolean defaultValue)
The argument value atname
as a boolean. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,Boolean
,String
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as aboolean
-
getByte
public static byte getByte(IArgs args, java.lang.String name, byte defaultValue)
The argument value atname
as a byte. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,Number
,String
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as a byte.
-
getChar
public static char getChar(IArgs args, java.lang.String name, char defaultValue)
The argument value atname
as a char. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,Character
,String
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as a char.
-
getCharArray
public static char[] getCharArray(IArgs args, java.lang.String name, char[] defaultValue) throws java.lang.IllegalArgumentException
The argument value atname
as a char[]. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,String
, char[]. Unlike the other conversion methods, this one throws an IllegalArgumentException, if the value is not of typeString
orchar[]
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as aString
. - Throws:
java.lang.IllegalArgumentException
- if value is not of typeString
orchar[]
-
getClass
public static java.lang.Class getClass(IArgs args, java.lang.String name, java.lang.Class defaultValue)
The argument value atname
as aClass
. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,Boolean
,String
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as aClass
.
-
getDate
public static java.util.Date getDate(IArgs args, java.lang.String name, java.util.Date defaultValue)
The argument value atname
as aDate
. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,Date
,String
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as aDate
.
-
getEnumItem
public static <T extends EnumItem> T getEnumItem(IArgs args, EnumMeta<T> meta, java.lang.String name)
The argument value atname
as aEnumItem
. If the argument value is not provided or not convertible, the enumeration default value is returned.This method performs the necessary casts and conversions. Supported input types are
null
,EnumItem
,String
.- Parameters:
args
-meta
-name
-- Returns:
- The argument value at
name
as aEnumItem
.
-
getEnumItem
public static <T extends EnumItem> T getEnumItem(IArgs args, EnumMeta<T> meta, java.lang.String name, java.lang.String defaultValue)
The argument value atname
as aEnumItem
. If the argument value is not provided or not convertible, the enumeration item with the iddefaultValuee
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,EnumItem
,String
.- Parameters:
args
-meta
-name
-- Returns:
- The argument value at
name
as aEnumItem
.
-
getFile
public static java.io.File getFile(IArgs args, java.lang.String name, java.io.File defaultValue)
The argument value atname
as aFile
. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,File
,String
,ILocator
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as aDate
.
-
getFloat
public static float getFloat(IArgs args, java.lang.String name, float defaultValue)
The argument value atname
as a float. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,Number
,String
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as a float.
-
getInt
public static int getInt(IArgs args, java.lang.String name, int defaultValue)
The argument value atname
as a int. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,Number
,String
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as a int.
-
getLocator
public static ILocator getLocator(IArgs args, java.lang.String name, ILocator defaultValue, ILocatorFactory factory)
The argument value atname
as aILocator
. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,ILocator
,String
,File
- Parameters:
args
-name
-defaultValue
-factory
-- Returns:
- The argument value at
name
as aILocator
.
-
getLocators
public static java.util.List<ILocator> getLocators(IArgs args, java.lang.String name, ILocatorFactory factory)
The argument value atname
as a List. If the argument value is not provided, null
is returned.This method performs the necessary casts and conversions. Supported input types are
Collection
ofILocator
,String
andFile
.- Parameters:
args
-name
-factory
-- Returns:
- The argument value at
name
as aList
.
-
getMap
public static java.util.Map getMap(IArgs args, java.lang.String name, java.util.Map defaultValue)
The argument value atname
as aMap
. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,Map
,String
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as aMap
.
-
getObject
public static java.lang.Object getObject(IArgs args, java.lang.String name, java.lang.Object defaultValue)
The argument value atname
as aObject
. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,Object
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as aObject
.
-
getPoint
public static java.awt.geom.Point2D getPoint(IArgs args, java.lang.String name, java.awt.geom.Point2D defaultValue)
The argument value atname
as aPoint2D
. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,Point2D
,String
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as aPoint2D
.
-
getString
public static java.lang.String getString(IArgs args, java.lang.String name, java.lang.String defaultValue)
The argument value atname
as aString
. If the argument value is not provided or not convertible,defaultValue
is returned.This method performs the necessary casts and conversions. Supported input types are
null
,String
,Object
.- Parameters:
args
-name
-defaultValue
-- Returns:
- The argument value at
name
as aString
.
-
prefix
public static java.lang.String prefix(java.lang.String prefix, java.lang.String name)
Create a new argument name fromname
by prefixing withprefix
.- Parameters:
prefix
-name
-- Returns:
- The new argument name.
-
toArgs
public static IArgs toArgs(java.lang.Object value)
Cast or convertvalue
to anIArgs
.- Parameters:
value
-- Returns:
- The
IArgs
created fromvalue
.
-
toList
public static java.util.List toList(IArgs args)
Convert theargs
to aList
.- Parameters:
args
-- Returns:
- The
List
representation of theargs
-
toMap
public static java.util.Map toMap(IArgs args)
Convert theargs
to aMap
.- Parameters:
args
-- Returns:
- The
Map
representation of theargs
-
toString
public static java.lang.String toString(IArgs args, java.lang.String prefix)
Create a printableString
forargs
.- Parameters:
args
-prefix
-- Returns:
-
toStringArgs
protected static void toStringArgs(java.lang.String prefix, java.lang.StringBuilder sb, java.lang.String name, IArgs value)
-
toStringPlain
protected static void toStringPlain(java.lang.String prefix, java.lang.StringBuilder sb, java.lang.String name, java.lang.Object value)
-
-