Package org.astrogrid.samp.web

Class WebHubProfileFactory

  • All Implemented Interfaces:
    HubProfileFactory
    public class WebHubProfileFactory
extends java.lang.Object
implements HubProfileFactory
    HubProfileFactory implementation for Web Profile.
    Since:
    2 Feb 2011
    Author:
    Mark Taylor

    • 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 the createProfile 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 "web".

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • WebHubProfileFactory

        public WebHubProfileFactory()

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns "web".
        Specified by:
        getName in interface HubProfileFactory
        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 the createProfile method.
        Specified by:
        getFlagsUsage in interface HubProfileFactory
        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 the HubProfileFactory.getFlagsUsage() command are used for configuration of the returned hub, and must be removed from the flagList 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 interface HubProfileFactory
        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 invoking HubProfileFactory.createHubProfile(java.util.List) with an empty flag list.
        Specified by:
        getHubProfileClass in interface HubProfileFactory
        Returns:
        HubProfile subclass with a public no-arg constructor