com.screenscraper.view.languagesupport.javadoc

Class ParameterizedDocumentation

java.lang.Object

com.screenscraper.view.languagesupport.javadoc.Documentation

com.screenscraper.view.languagesupport.javadoc.ParameterizedDocumentation

Direct Known Subclasses:

ConstructorDocumentation, MethodDocumentation

public abstract class ParameterizedDocumentation
extends Documentation

Class Description

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<ThrownExceptionDocumentation>	exceptions
protected java.util.List<VariableDocumentation>	parameters

Fields inherited from class com.screenscraper.view.languagesupport.javadoc.Documentation

deprecated, description, name, type, typeClass

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class com.screenscraper.view.languagesupport.javadoc.Documentation

getDescription, getName, getNonNullDescription, getType, getTypeClass, isDeprecated, setDeprecated

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

parameters

@NotNull
protected final java.util.List<VariableDocumentation> parameters

exceptions

@NotNull
protected final java.util.Set<ThrownExceptionDocumentation> exceptions

Constructor Detail

ParameterizedDocumentation

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)

Create documentation for a type that has parameters

Parameters:

typeClass - The actual class of the return type if known

type - The return type, or object type

name - The name of the documented item

description - The description of the item

parameters - A list, in order, of the documentation for each parameter. A value of null is the same as an empty list

exceptions - A set of the documentation for each exception thrown. A value of null is the same as an empty set

Method Detail

getParameterTypes

@NotNull
public java.lang.Class[] getParameterTypes()

Returns the types of the parameters

Returns:

The types of the parameters

getParameters

@NotNull
public java.util.List<VariableDocumentation> getParameters()

Returns a copy of the documentation parameters. It is safe to modify the list.

Returns:

A copy of the documentation parameters. It is safe to modify the list.

getExceptions

@NotNull
public java.util.Set<ThrownExceptionDocumentation> getExceptions()

Returns a copy of the documentation exceptions. It is safe to modify the list.

Returns:

A copy of the documentation exceptions. It is safe to modify the list.

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class Documentation

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Documentation

hashCode

public int hashCode()

Overrides:

hashCode in class Documentation