Package org.astrogrid.samp.xmlrpc
Class StandardHubProfileFactory
- java.lang.Object
-
- org.astrogrid.samp.xmlrpc.StandardHubProfileFactory
-
- All Implemented Interfaces:
HubProfileFactory
public class StandardHubProfileFactory extends java.lang.Object implements HubProfileFactory
HubProfileFactory implementation for Standard Profile.- Since:
- 31 Jan 2011
- Author:
- Mark Taylor
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
lockUsage_
private static java.lang.String
secretUsage_
-
Constructor Summary
Constructors Constructor Description StandardHubProfileFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HubProfile
createHubProfile(java.util.List flagList)
Creates a HubProfile perhaps configured using a supplied list of flags.java.lang.String[]
getFlagsUsage()
Returns an array of strings, each describing one command-line flag which will be consumed by thecreateProfile
method.java.lang.Class
getHubProfileClass()
Returns a HubProfile subclass with a no-arg constructor which, when invoked, will produce a basic instance of the HubProfile represented by this factory.java.lang.String
getName()
Returns "std".
-
-
-
Field Detail
-
secretUsage_
private static final java.lang.String secretUsage_
- See Also:
- Constant Field Values
-
lockUsage_
private static final java.lang.String lockUsage_
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
public java.lang.String getName()
Returns "std".- Specified by:
getName
in interfaceHubProfileFactory
- Returns:
- short name
-
getFlagsUsage
public java.lang.String[] getFlagsUsage()
Description copied from interface:HubProfileFactory
Returns an array of strings, each describing one command-line flag which will be consumed by thecreateProfile
method.- Specified by:
getFlagsUsage
in interfaceHubProfileFactory
- Returns:
- array of plain-text strings suitable for use as part of a usage message
-
createHubProfile
public HubProfile createHubProfile(java.util.List flagList) throws java.io.IOException
Description copied from interface:HubProfileFactory
Creates a HubProfile perhaps configured using a supplied list of flags. Any flags which match those described by theHubProfileFactory.getFlagsUsage()
command are used for configuration of the returned hub, and must be removed from theflagList
list. Unrecognised flags should be ignored and left in the list. Flags which are recognised but badly formed should raise a RuntimeException with a helpful message.- Specified by:
createHubProfile
in interfaceHubProfileFactory
- Parameters:
flagList
- mutable list of Strings giving command-ilne flags, some of which may be intended for configuring a profile- Returns:
- new profile
- Throws:
java.io.IOException
-
getHubProfileClass
public java.lang.Class getHubProfileClass()
Description copied from interface:HubProfileFactory
Returns a HubProfile subclass with a no-arg constructor which, when invoked, will produce a basic instance of the HubProfile represented by this factory. The instance thus produced will typically be similar to that produced by invokingHubProfileFactory.createHubProfile(java.util.List)
with an empty flag list.- Specified by:
getHubProfileClass
in interfaceHubProfileFactory
- Returns:
- HubProfile subclass with a public no-arg constructor
-
-