com.screenscraper.view.languagesupport.javadoc

Class ClassDocumentation

java.lang.Object

com.screenscraper.view.languagesupport.javadoc.Documentation

com.screenscraper.view.languagesupport.javadoc.ClassDocumentation

public class ClassDocumentation
extends Documentation

Class Description

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static ClassDocumentation	NULL Null object for the class

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

deprecated, name, type, typeClass

Constructor Summary

Constructors

Constructor and Description
ClassDocumentation(java.lang.Class documentedClass) Creates the documentation for the given class
ClassDocumentation(java.lang.Class documentedClass, java.lang.String description) Creates the documentation for the given class
ClassDocumentation(java.lang.String name, java.lang.String description, java.lang.Class documentedClass) Creates the documentation for the given class

Method Summary

Modifier and Type	Method and Description
void	addConstructorDocumentation(ConstructorDocumentation documentation) Adds the documentation for the given constructor
void	addFieldDocumentation(VariableDocumentation documentation) Adds the documentation for the given constructor
void	addMethodDocumentation(MethodDocumentation documentation) Adds the documentation for the given method
boolean	equals(java.lang.Object o)
ConstructorDocumentation	getConstructorDocumentation(java.lang.reflect.Constructor constructor) Returns the documentation for the given constructor, or ConstructorDocumentation.NULL if no documentation is found
java.util.Set<ConstructorDocumentation>	getConstructors() Returns the constructors documented in this class
java.lang.Class	getDocumentedClass() Returns the class this documents, or null if it doesn't document any class
VariableDocumentation	getFieldDocumentation(java.lang.reflect.Field field) Returns the documentation for the given field, or VariableDocumentation.NULL if no documentation is found
java.util.Set<VariableDocumentation>	getFields() Returns the fields documented in this class
MethodDocumentation	getMethodDocumentation(java.lang.reflect.Method method) Returns the documentation for the given method, or MethodDocumentation.NULL if no documentation is found
java.util.Set<MethodDocumentation>	getMethods() Returns the methods documented in this class
int	hashCode()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NULL

@NotNull
public static final ClassDocumentation NULL

Null object for the class

Constructor Detail

ClassDocumentation

public ClassDocumentation(@NotNull
                          java.lang.Class documentedClass)

Creates the documentation for the given class

Parameters:

documentedClass - The class this documentation represents

ClassDocumentation

public ClassDocumentation(@NotNull
                          java.lang.Class documentedClass,
                          @Nullable
                          java.lang.String description)

Creates the documentation for the given class

Parameters:

documentedClass - The class this documentation represents

description - The class description, as HTML

ClassDocumentation

public ClassDocumentation(@NotNull
                          java.lang.String name,
                          @Nullable
                          java.lang.String description,
                          @Nullable
                          java.lang.Class documentedClass)

Creates the documentation for the given class

Parameters:

name - The name to use for this documentation

description - The class description, as HTML

documentedClass - The class this documentation represents

Method Detail

getMethodDocumentation

@NotNull
public MethodDocumentation getMethodDocumentation(java.lang.reflect.Method method)

Returns the documentation for the given method, or MethodDocumentation.NULL if no documentation is found

Parameters:

method - The method to get documentation for

Returns:

The documentation for the method

getFieldDocumentation

@NotNull
public VariableDocumentation getFieldDocumentation(java.lang.reflect.Field field)

Returns the documentation for the given field, or VariableDocumentation.NULL if no documentation is found

Parameters:

field - The field to get documentation for

Returns:

The documentation for the field

getConstructorDocumentation

@NotNull
public ConstructorDocumentation getConstructorDocumentation(java.lang.reflect.Constructor constructor)

Returns the documentation for the given constructor, or ConstructorDocumentation.NULL if no documentation is found

Parameters:

constructor - The method to get documentation for

Returns:

The documentation for the constructor

addMethodDocumentation

public void addMethodDocumentation(@NotNull
                                   MethodDocumentation documentation)

Adds the documentation for the given method

Parameters:

documentation - The documentation to add

addConstructorDocumentation

public void addConstructorDocumentation(@NotNull
                                        ConstructorDocumentation documentation)

Adds the documentation for the given constructor

Parameters:

documentation - The documentation to constructor

addFieldDocumentation

public void addFieldDocumentation(@NotNull
                                  VariableDocumentation documentation)

Adds the documentation for the given constructor

Parameters:

documentation - The documentation to constructor

getFields

@NotNull
public java.util.Set<VariableDocumentation> getFields()

Returns the fields documented in this class

Returns:

The fields documented in this class

getConstructors

@NotNull
public java.util.Set<ConstructorDocumentation> getConstructors()

Returns the constructors documented in this class

Returns:

The constructors documented in this class

getMethods

@NotNull
public java.util.Set<MethodDocumentation> getMethods()

Returns the methods documented in this class

Returns:

The methods documented in this class

getDocumentedClass

@Nullable
public java.lang.Class getDocumentedClass()

Returns the class this documents, or null if it doesn't document any class

Returns:

The class this documents, or null if it doesn't document any class

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Documentation

hashCode

public int hashCode()

Overrides:

hashCode in class Documentation