com.screenscraper.view.languagesupport.javadoc

Class ConstructorDocumentation

java.lang.Object

com.screenscraper.view.languagesupport.javadoc.Documentation

com.screenscraper.view.languagesupport.javadoc.ParameterizedDocumentation

com.screenscraper.view.languagesupport.javadoc.ConstructorDocumentation

public class ConstructorDocumentation
extends ParameterizedDocumentation

Class Description

Version:

1.0

Field Summary

Fields

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

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

exceptions, parameters

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

deprecated, description, name, type, typeClass

Constructor Summary

Constructors

Constructor and Description
ConstructorDocumentation(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, java.lang.reflect.Constructor constructor) Builds the documentation for a constructor

Method Summary

Modifier and Type	Method and Description
java.lang.reflect.Constructor	getConstructor() Returns the documented constructor, or null if unknown
boolean	setConstructor(java.lang.reflect.Constructor constructor) Sets the documented constructor.

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

equals, getExceptions, getParameters, getParameterTypes, hashCode, 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

NULL

@NotNull
public static final ConstructorDocumentation NULL

Null object for the class

Constructor Detail

ConstructorDocumentation

public ConstructorDocumentation(@Nullable
                                java.lang.Class<?> typeClass,
                                @NotNull
                                java.lang.String type,
                                @NotNull
                                java.lang.String name,
                                @Nullable
                                java.lang.String description,
                                @NotNull
                                java.util.List<VariableDocumentation> parameters,
                                @NotNull
                                java.util.Set<ThrownExceptionDocumentation> exceptions,
                                @Nullable
                                java.lang.reflect.Constructor constructor)

Builds the documentation for a constructor

Parameters:

typeClass - The actual class of the constructed object if known

type - The return type (should be the same as the name)

name - The name of the constructor

description - The description of the constructor

parameters - A list of parameters taken by the constructor

exceptions - A list of exceptions thrown by the constructor

constructor - The constructor that is being documented

Method Detail

getConstructor

@Nullable
public java.lang.reflect.Constructor getConstructor()

Returns the documented constructor, or null if unknown

Returns:

The documented constructor, or null if unknown

setConstructor

public boolean setConstructor(@Nullable
                              java.lang.reflect.Constructor constructor)

Sets the documented constructor. On null doesn't modify it

Parameters:

constructor - The documented constructor

Returns:

True if the value was updated, false otherwise