org.docgene.model

Class APIMember

java.lang.Object

org.docgene.model.APIMember

public class APIMember
extends java.lang.Object

An API member declaration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	APIMember.Argument An API member argument.

Constructor Summary

Constructors

Constructor and Description
APIMember(java.lang.String member) Constructor.

Method Summary

Modifier and Type	Method and Description
APIMember.Argument	addArgument(java.lang.String name, java.lang.String rep) Add an argument.
java.util.List<APIMember.Argument>	getArguments() Return the list of arguments.
java.lang.String	getMember() Return the member.
java.lang.String	getSimpleMember() Return the member simple representation.
boolean	hasArguments() Return true if there are arguments.
void	setMember(java.lang.String member) Set the member.
void	setSimpleMember(java.lang.String simpleMember) Set the simple representation of the member.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

APIMember

public APIMember(java.lang.String member)

Constructor.

Parameters:

member - the member

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addArgument

public APIMember.Argument addArgument(java.lang.String name,
                                      java.lang.String rep)

Add an argument.

Parameters:

name - the argument name

rep - the argument representation

Returns:

the argument

getArguments

public java.util.List<APIMember.Argument> getArguments()

Return the list of arguments.

Returns:

the list of arguments

hasArguments

public boolean hasArguments()

Return true if there are arguments.

Returns:

true if there are arguments

setMember

public void setMember(java.lang.String member)

Set the member.

Parameters:

member - the member

setSimpleMember

public void setSimpleMember(java.lang.String simpleMember)

Set the simple representation of the member.

Parameters:

simpleMember - the member simple representation

getMember

public java.lang.String getMember()

Return the member.

Returns:

the member

getSimpleMember

public java.lang.String getSimpleMember()

Return the member simple representation.

Returns:

the member simple representation