public static class ParameterizedCompletion.Parameter extends Object
Completion
.Constructor and Description |
---|
ParameterizedCompletion.Parameter(Object type,
String name)
Constructor.
|
ParameterizedCompletion.Parameter(Object type,
String name,
boolean endParam)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
getDescription() |
String |
getName() |
String |
getType()
Returns the type of this parameter, as a string.
|
Object |
getTypeObject()
Returns the object used to describe the type of this parameter.
|
boolean |
isEndParam() |
void |
setDescription(String desc) |
String |
toString() |
public ParameterizedCompletion.Parameter(Object type, String name)
type
- The type of this parameter. This may be
null
for languages without specific types,
dynamic typing, etc. Usually you'll pass a String for this
value, but you may pass any object representing a type in
your language, as long as its toString()
method
returns a string representation of the type.name
- The name of the parameter.public ParameterizedCompletion.Parameter(Object type, String name, boolean endParam)
type
- The type of this parameter. This may be
null
for languages without specific types,
dynamic typing, etc. Usually you'll pass a String for this
value, but you may pass any object representing a type in
your language, as long as its toString()
method
returns a string representation of the type.name
- The name of the parameter.endParam
- Whether this parameter is an "ending parameter;"
that is, whether this parameter is at a logical "ending
point" in the completion text. If the user types in a
parameter that is an ending point, parameter completion mode
terminates. Set this to true
for a trailing
parameter after a function call's closing ')', for example.public String getDescription()
public String getName()
public String getType()
null
for none.public Object getTypeObject()
null
for none.public boolean isEndParam()
public void setDescription(String desc)