Java Doc for AbstractParameter.java in  » GIS » GeoTools-2.4.1 » org » geotools » parameter » 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 » GIS » GeoTools 2.4.1 » org.geotools.parameter 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.geotools.referencing.wkt.Formattable
      org.geotools.parameter.AbstractParameter

All known Subclasses:   org.geotools.parameter.Parameter,  org.geotools.parameter.ParameterGroup,  org.geotools.parameter.ImagingParameter,  org.geotools.parameter.FloatParameter,  org.geotools.parameter.ImagingParameters,
AbstractParameter
abstract public class AbstractParameter extends Formattable implements GeneralParameterValue,Serializable(Code)
Abstract parameter value or group of parameter values.
since:
   2.1
version:
   $Id: AbstractParameter.java 23632 2006-12-29 22:13:51Z desruisseaux $
author:
   Martin Desruisseaux
See Also:   AbstractParameterDescriptor


Field Summary
final  GeneralParameterDescriptordescriptor
     The abstract definition of this parameter or group of parameters.

Constructor Summary
protected  AbstractParameter(GeneralParameterDescriptor descriptor)
     Constructs a parameter value from the specified descriptor.

Method Summary
public  Objectclone()
     Returns a copy of this parameter value or group.
static  voidensureNonNull(String name, Object object)
     Makes sure that an argument is non-null.
static  voidensureNonNull(String name, Object[] array, int index)
     Makes sure an array element is non-null.
static  voidensureValidClass(Class valueClass, Object value)
     Verify that the specified value is of the specified class.
public  booleanequals(Object object)
     Compares the specified object with this parameter for equality.
Parameters:
  object - The object to compare to this .
final protected  StringformatWKT(Formatter formatter)
     Format the inner part of this parameter as Well Known Text (WKT).
public  GeneralParameterDescriptorgetDescriptor()
     Returns the abstract definition of this parameter or group of parameters.
static  StringgetName(GeneralParameterDescriptor descriptor)
     Convenience method returning the name of the specified descriptor.
public  inthashCode()
     Returns a hash value for this parameter.
final public  StringtoString()
     Returns a string representation of this parameter.
static  IllegalStateExceptionunitlessParameter(GeneralParameterDescriptor descriptor)
     Returns an exception initialized with a "Unitless parameter" error message for the specified descriptor.
protected  voidwrite(TableWriter table)
     Write the content of this parameter to the specified table.

Field Detail
descriptor
final GeneralParameterDescriptor descriptor(Code)
The abstract definition of this parameter or group of parameters.




Constructor Detail
AbstractParameter
protected AbstractParameter(GeneralParameterDescriptor descriptor)(Code)
Constructs a parameter value from the specified descriptor.
Parameters:
  descriptor - The abstract definition of this parameter or group of parameters.




Method Detail
clone
public Object clone()(Code)
Returns a copy of this parameter value or group.



ensureNonNull
static void ensureNonNull(String name, Object object) throws IllegalArgumentException(Code)
Makes sure that an argument is non-null. This method was already defined in org.geotools.referencing.AbstractIdentifiedObject , but is defined here again in order to get a more appropriate stack trace, and for access by class which do not inherit from org.geotools.referencing.AbstractIdentifiedObject .
Parameters:
  name - Argument name.
Parameters:
  object - User argument.
throws:
  IllegalArgumentException - if object is null.



ensureNonNull
static void ensureNonNull(String name, Object[] array, int index) throws IllegalArgumentException(Code)
Makes sure an array element is non-null. This is a convenience method for subclass constructors.
Parameters:
  name - Argument name.
Parameters:
  array - The array to look at.
Parameters:
  index - Index of the element to check.
throws:
  IllegalArgumentException - if array[i] is null.



ensureValidClass
static void ensureValidClass(Class valueClass, Object value) throws IllegalArgumentException(Code)
Verify that the specified value is of the specified class.
Parameters:
  valueClass - the expected class.
Parameters:
  value - The expected value, or null .
throws:
  IllegalArgumentException - if value is non-null and has a non-assignableclass.



equals
public boolean equals(Object object)(Code)
Compares the specified object with this parameter for equality.
Parameters:
  object - The object to compare to this . true if both objects are equal.



formatWKT
final protected String formatWKT(Formatter formatter)(Code)
Format the inner part of this parameter as Well Known Text (WKT). This method doesn't need to be overridden, since the formatter already know how to .



getDescriptor
public GeneralParameterDescriptor getDescriptor()(Code)
Returns the abstract definition of this parameter or group of parameters.



getName
static String getName(GeneralParameterDescriptor descriptor)(Code)
Convenience method returning the name of the specified descriptor. This method is used mostly for output to be read by human, not for processing. Consequently, we may consider to returns a localized name in a future version.



hashCode
public int hashCode()(Code)
Returns a hash value for this parameter. This value doesn't need to be the same in past or future versions of this class.



toString
final public String toString()(Code)
Returns a string representation of this parameter. The default implementation delegates the work to AbstractParameter.write , which should be overridden by subclasses.



unitlessParameter
static IllegalStateException unitlessParameter(GeneralParameterDescriptor descriptor)(Code)
Returns an exception initialized with a "Unitless parameter" error message for the specified descriptor.



write
protected void write(TableWriter table) throws IOException(Code)
Write the content of this parameter to the specified table. This method make it easier to align values properly than overriding the AbstractParameter.toString method. The table's columns are defined as below:
  1. The parameter name
  2. The separator
  3. The parameter value

The default implementation is suitable for most cases. However, subclasses are free to override this method with the following idiom:

 table.
 ("parameter name");
 table.
 ()
 table.
 ('=');
 table.
 ()
 table.
 ("parameter value");
 table.
 ()
 

Parameters:
  table - The table where to format the parameter value.
throws:
  IOException - if an error occurs during output operation.



Methods inherited from org.geotools.referencing.wkt.Formattable
protected String formatWKT(Formatter formatter)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public String toWKT() throws UnformattableObjectException(Code)(Java Doc)
public String toWKT(int indentation) throws UnformattableObjectException(Code)(Java Doc)
public String toWKT(Citation authority, int indentation) throws UnformattableObjectException(Code)(Java Doc)

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)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.