Constructor Detail

• 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 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.

• 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)

• toString

  public String toString()

  Overrides:

  toString in class Object