|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Subject to change. Metadata for a parameter that is of use for building documentation or user interfaces for parameters. The fields are not required and thus the methods of this class may return null.
Parameter.setInfo(ParameterInfo)
,
Parameter.getInfo()
Field Summary | |
static String |
versionId
|
Method Summary | |
String |
getExample()
Gets an example value for the parameter. |
String |
getFormat()
Gets a format description. |
String |
getPurpose()
Gets the parameter's reason for being. |
String |
getTitle()
Gets the pretty name of the parameter. |
Field Detail |
public static final String versionId
Method Detail |
public String getTitle()
String
title of the parameter; it may
be nullpublic String getPurpose()
String
purpose of the parameter; it
may be nullpublic String getExample()
String
example value; it may be nullpublic String getFormat()
String
; it may be null
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |