Package org.fife.ui.autocomplete

Class ParameterizedCompletion.Parameter

java.lang.Object

org.fife.ui.autocomplete.ParameterizedCompletion.Parameter

Enclosing interface:

ParameterizedCompletion

public static class ParameterizedCompletion.Parameter
extends Object

A parameter passed to a parameterized Completion.

Constructor Summary

Constructors

Constructor	Description
Parameter(Object type, String name)	Constructor.
Parameter(Object type, String name, boolean endParam)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of this completion.
String	getName()	Returns the name of this completion.
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)	Sets the description of this completion.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Parameter

public Parameter(Object type,
 String name)

Constructor.

Parameters:

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.

Parameter

public Parameter(Object type,
 String name,
 boolean endParam)

Constructor.

Parameters:

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.

Method Details

getDescription

public String getDescription()

Returns the description of this completion.

Returns:

The description of this completion.

getName

public String getName()

Returns the name of this completion.

Returns:

The name of this completion.

getType

public String getType()

Returns the type of this parameter, as a string.

Returns:

The type of the parameter, or null for none.

getTypeObject

public Object getTypeObject()

Returns the object used to describe the type of this parameter.

Returns:

The type object, or null for none.

isEndParam

public boolean isEndParam()

Returns:

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.

setDescription

public void setDescription(String desc)

Sets the description of this completion.

Parameters:

desc - The description.

See Also:

• getDescription()

toString

public String toString()

Overrides:

toString in class Object