public abstract class ParameterizedDocumentation extends Documentation
Modifier and Type | Field and Description |
---|---|
protected java.util.Set<ThrownExceptionDocumentation> |
exceptions |
protected java.util.List<VariableDocumentation> |
parameters |
deprecated, description, name, type, typeClass
Modifier | Constructor and Description |
---|---|
protected |
ParameterizedDocumentation(java.lang.Class<?> typeClass,
java.lang.String type,
java.lang.String name,
java.lang.String description,
java.util.List<VariableDocumentation> parameters,
java.util.Set<ThrownExceptionDocumentation> exceptions)
Create documentation for a type that has parameters
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o) |
java.util.Set<ThrownExceptionDocumentation> |
getExceptions()
Returns a copy of the documentation exceptions.
|
java.util.List<VariableDocumentation> |
getParameters()
Returns a copy of the documentation parameters.
|
java.lang.Class[] |
getParameterTypes()
Returns the types of the parameters
|
int |
hashCode() |
java.lang.String |
toString() |
getDescription, getName, getNonNullDescription, getType, getTypeClass, isDeprecated, setDeprecated
@NotNull protected final java.util.List<VariableDocumentation> parameters
@NotNull protected final java.util.Set<ThrownExceptionDocumentation> exceptions
protected ParameterizedDocumentation(@Nullable java.lang.Class<?> typeClass, @NotNull java.lang.String type, @NotNull java.lang.String name, @Nullable java.lang.String description, @Nullable java.util.List<VariableDocumentation> parameters, @Nullable java.util.Set<ThrownExceptionDocumentation> exceptions)
typeClass
- The actual class of the return type if knowntype
- The return type, or object typename
- The name of the documented itemdescription
- The description of the itemparameters
- A list, in order, of the documentation for each parameter. A value of null is the same as an empty listexceptions
- A set of the documentation for each exception thrown. A value of null is the same as an empty set@NotNull public java.lang.Class[] getParameterTypes()
@NotNull public java.util.List<VariableDocumentation> getParameters()
@NotNull public java.util.Set<ThrownExceptionDocumentation> getExceptions()
@NotNull public java.lang.String toString()
toString
in class Documentation
public boolean equals(java.lang.Object o)
equals
in class Documentation
public int hashCode()
hashCode
in class Documentation