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.

Version:

1.0

Author:

Robert Futrell

Constructor Summary

ParameterizedCompletion.Parameter(Object type, String name)
Constructor.

Method Summary

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.
void	setDescription(String desc)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterizedCompletion.Parameter

public ParameterizedCompletion.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.

Method Detail

getDescription

public String getDescription()

getName

public String getName()

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.

setDescription

public void setDescription(String desc)

toString

public String toString()

Overrides:

toString in class Object