Java Doc for ParameterList.java in » 6.0-JDK-Modules » Java-Advanced-Imaging » javax » media » jai » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 » 6.0 JDK Modules » Java Advanced Imaging » javax.media.jai

Source Cross Reference Class Diagram Java Document (Java Doc)

javax.media.jai .ParameterList

All known Subclasses:   javax.media.jai .ParameterBlockJAI,  javax.media.jai .ParameterListImpl,
ParameterList
public interface ParameterList (Code)
An interface to represent a list of parameter name-value pairs.
All comparisons using Strings are done in a case insensitive (but retentive) manner.
See Also:   ParameterListDescriptor
since:
   JAI 1.1

Method Summary
public boolean getBooleanParameter(String paramName)
     A convenience method to return a parameter as a boolean.
public byte getByteParameter(String paramName)
     A convenience method to return a parameter as a byte.
public char getCharParameter(String paramName)
     A convenience method to return a parameter as a char.
public double getDoubleParameter(String paramName)
     A convenience method to return a parameter as a double.
public float getFloatParameter(String paramName)
     A convenience method to return a parameter as a float.
public int getIntParameter(String paramName)
     A convenience method to return a parameter as an int.
public long getLongParameter(String paramName)
     A convenience method to return a parameter as a long.
public Object getObjectParameter(String paramName)
     Gets a named parameter as an Object.
public ParameterListDescriptor getParameterListDescriptor()
     Returns the associated ParameterListDescriptor.
public short getShortParameter(String paramName)
     A convenience method to return a parameter as a short.
public ParameterList setParameter(String paramName, byte b)
     Sets a named parameter to a byte value.
public ParameterList setParameter(String paramName, boolean b)
     Sets a named parameter to a boolean value.
public ParameterList setParameter(String paramName, char c)
     Sets a named parameter to a char value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  c - a char value for the parameter.
public ParameterList setParameter(String paramName, short s)
     Sets a named parameter to a short value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  s - a short value for the parameter.
public ParameterList setParameter(String paramName, int i)
     Sets a named parameter to an int value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  i - an int value for the parameter.
public ParameterList setParameter(String paramName, long l)
     Sets a named parameter to a long value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  l - a long value for the parameter.
public ParameterList setParameter(String paramName, float f)
     Sets a named parameter to a float value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  f - a float value for the parameter.
public ParameterList setParameter(String paramName, double d)
     Sets a named parameter to a double value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  d - a double value for the parameter.
public ParameterList setParameter(String paramName, Object obj)
     Sets a named parameter to an Object value.

Method Detail
getBooleanParameter
public boolean getBooleanParameter(String paramName)(Code)
A convenience method to return a parameter as a boolean.
Parameters:
  paramName - the name of the parameter to be returned.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.
throws:
  ClassCastException - if the parameter is of a different type.
throws:
  IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT

getByteParameter
public byte getByteParameter(String paramName)(Code)
A convenience method to return a parameter as a byte.
Parameters:
  paramName - the name of the parameter to be returned.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.
throws:
  ClassCastException - if the parameter is of a different type.
throws:
  IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT

getCharParameter
public char getCharParameter(String paramName)(Code)
A convenience method to return a parameter as a char.
Parameters:
  paramName - the name of the parameter to be returned.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.
throws:
  ClassCastException - if the parameter is of a different type.
throws:
  IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT

getDoubleParameter
public double getDoubleParameter(String paramName)(Code)
A convenience method to return a parameter as a double.
Parameters:
  paramName - the name of the parameter to be returned.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.
throws:
  ClassCastException - if the parameter is of a different type.
throws:
  IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT

getFloatParameter
public float getFloatParameter(String paramName)(Code)
A convenience method to return a parameter as a float.
Parameters:
  paramName - the name of the parameter to be returned.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.
throws:
  ClassCastException - if the parameter is of a different type.
throws:
  IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT

getIntParameter
public int getIntParameter(String paramName)(Code)
A convenience method to return a parameter as an int.
Parameters:
  paramName - the name of the parameter to be returned.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.
throws:
  ClassCastException - if the parameter is of a different type.
throws:
  IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT

getLongParameter
public long getLongParameter(String paramName)(Code)
A convenience method to return a parameter as a long.
Parameters:
  paramName - the name of the parameter to be returned.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.
throws:
  ClassCastException - if the parameter is of a different type.
throws:
  IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT

getObjectParameter
public Object getObjectParameter(String paramName)(Code)
Gets a named parameter as an Object. Parameters belonging to a primitive type, such as int, will be returned as a member of the corresponding wrapper class, such as Integer.
Parameters:
  paramName - the name of the parameter to be returned.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.
throws:
  IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT

getParameterListDescriptor
public ParameterListDescriptor getParameterListDescriptor()(Code)
Returns the associated ParameterListDescriptor.

getShortParameter
public short getShortParameter(String paramName)(Code)
A convenience method to return a parameter as a short.
Parameters:
  paramName - the name of the parameter to be returned.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.
throws:
  ClassCastException - if the parameter is of a different type.
throws:
  IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT

setParameter
public ParameterList setParameter(String paramName, byte b)(Code)
Sets a named parameter to a byte value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  b - a byte value for the parameter.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.

setParameter
public ParameterList setParameter(String paramName, boolean b)(Code)
Sets a named parameter to a boolean value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  b - a boolean value for the parameter.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.

setParameter
public ParameterList setParameter(String paramName, char c)(Code)
Sets a named parameter to a char value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  c - a char value for the parameter.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.

setParameter
public ParameterList setParameter(String paramName, short s)(Code)
Sets a named parameter to a short value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  s - a short value for the parameter.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.

setParameter
public ParameterList setParameter(String paramName, int i)(Code)
Sets a named parameter to an int value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  i - an int value for the parameter.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.

setParameter
public ParameterList setParameter(String paramName, long l)(Code)
Sets a named parameter to a long value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  l - a long value for the parameter.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.

setParameter
public ParameterList setParameter(String paramName, float f)(Code)
Sets a named parameter to a float value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  f - a float value for the parameter.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.

setParameter
public ParameterList setParameter(String paramName, double d)(Code)
Sets a named parameter to a double value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  d - a double value for the parameter.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.

setParameter
public ParameterList setParameter(String paramName, Object obj)(Code)
Sets a named parameter to an Object value. Implementing classes are free but not required to check class type, ranges, and enumeration types.
Parameters:
  paramName - a String naming a parameter.
Parameters:
  obj - an Object value for the parameter.
throws:
  IllegalArgumentException - if paramName is null.
throws:
  IllegalArgumentException - if there is no parameter with thespecified name.pointed to by the paramName.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.