Java Doc for ConfigOption.java in  » Web-Server » pygmy-httpd » pygmy » core » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Server » pygmy httpd » pygmy.core   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    pygmy.core.ConfigOption ConfigOption public class ConfigOption (Code) This class is used by handlers or endpoints to tell the server which options are used to configure the object. Field Summary  String defaultValue       String helpString       boolean isRequired       String propertyName      Constructor Summary public   ConfigOption(String propertyName, String helpString)      This is used to create an optional property that defaults to null if unspecified. public   ConfigOption(String propertyName, String defaultValue, String helpString)      This is used to create an optional property that has a supplied default value. public   ConfigOption(String propertyName, boolean required, String helpString)      This is used to create a required property. Method Summary public  Boolean getBoolean(Server server, String name)      This is used to fetch the value of the property as a Boolean. public  Integer getInteger(Server server, String name)      This is used to fetch the value of the property as an Integer. public  String getName()      The name of the configuration property that this ConfigOption was constructed with. public  String getProperty(Server server, String name)      This is used to fetch the value of the property. public  String toHelp()      This method is used to return a user viewable help string in case an object was misconfigured. Field Detail defaultValue String defaultValue(Code) helpString String helpString(Code) isRequired boolean isRequired(Code) propertyName String propertyName(Code) Constructor Detail ConfigOption public ConfigOption(String propertyName, String helpString)(Code) This is used to create an optional property that defaults to null if unspecified. Parameters:   propertyName - the name of the property. Parameters:   helpString - the help string shown to the user. ConfigOption public ConfigOption(String propertyName, String defaultValue, String helpString)(Code) This is used to create an optional property that has a supplied default value. Parameters:   propertyName - the name of the property. Parameters:   defaultValue - the default value used if this property is unspecified. Parameters:   helpString - the help string shown to the user. ConfigOption public ConfigOption(String propertyName, boolean required, String helpString)(Code) This is used to create a required property. There is no default supplied in the case where required is true. If you specify it as false it's the same as an optional property with no default. Parameters:   propertyName - the name of the property. Parameters:   required - Used to specify a required property. True for required, false for optional. Parameters:   helpString - the help string shown to the user if nothing is specified. Method Detail getBoolean public Boolean getBoolean(Server server, String name)(Code) This is used to fetch the value of the property as a Boolean. It will return the default property if it's not specified. Parameters:   server - the Server object used by the system. Parameters:   name - the name of the handler or endpoint instance. a Boolean value of the property or the default value if it was supplied in the constructor. getInteger public Integer getInteger(Server server, String name)(Code) This is used to fetch the value of the property as an Integer. It will return the default property if it's not specified. Parameters:   server - the Server object used by the system. Parameters:   name - the name of the handler or endpoint instance. an Integer value of the property or the default value if it was supplied in the constructor. getName public String getName()(Code) The name of the configuration property that this ConfigOption was constructed with. the propery's name. getProperty public String getProperty(Server server, String name)(Code) This is used to fetch the value of the property. It's returned as a String. It will return the default property if it's not specified. Parameters:   server - the Server object used by the system. Parameters:   name - the name of the handler or endpoint instance. the value of the property or the default value if it was supplied in the constructor. toHelp public String toHelp()(Code) This method is used to return a user viewable help string in case an object was misconfigured. the user viewable string for misconfigured properties. Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)