com.screenscraper.view.languagesupport.javadoc

Class MethodDocumentation

java.lang.Object

com.screenscraper.view.languagesupport.javadoc.Documentation

com.screenscraper.view.languagesupport.javadoc.ParameterizedDocumentation

com.screenscraper.view.languagesupport.javadoc.MethodDocumentation

public class MethodDocumentation
extends ParameterizedDocumentation

Class Description

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static MethodDocumentation	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
MethodDocumentation(java.lang.Class<?> typeClass, java.lang.String type, java.lang.String name, java.lang.String description, java.lang.String returnDescription, java.util.List<VariableDocumentation> parameters, java.util.Set<ThrownExceptionDocumentation> exceptions, java.lang.reflect.Method method) Creates documentation for a method

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
java.lang.reflect.Method	getMethod() Returns the documented method, or null if unknown
java.lang.String	getNonNullReturnDescription() Gets the description of the return value, or if null returns a non-null string
java.lang.String	getReturnDescription() Gets the description of the return value
boolean	setMethod(java.lang.reflect.Method method) Sets the documented method.

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

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 MethodDocumentation NULL

Null object for the class

Constructor Detail

MethodDocumentation

public MethodDocumentation(@Nullable
                           java.lang.Class<?> typeClass,
                           @NotNull
                           java.lang.String type,
                           @NotNull
                           java.lang.String name,
                           @Nullable
                           java.lang.String description,
                           @Nullable
                           java.lang.String returnDescription,
                           @NotNull
                           java.util.List<VariableDocumentation> parameters,
                           @NotNull
                           java.util.Set<ThrownExceptionDocumentation> exceptions,
                           @Nullable
                           java.lang.reflect.Method method)

Creates documentation for a method

Parameters:

typeClass - The actual class of the return type if known

type - The return type of the method

name - The name of the method

description - The description of the method

returnDescription - A description of the return value of the method

parameters - A list, in order, of the method parameter documentations

exceptions - A set of the exceptions documentations for thrown exceptions

method - The method that is being documented

Method Detail

getMethod

@Nullable
public java.lang.reflect.Method getMethod()

Returns the documented method, or null if unknown

Returns:

The documented method, or null if unknown

setMethod

public boolean setMethod(@Nullable
                         java.lang.reflect.Method method)

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

Parameters:

method - The documented method

Returns:

True if the value was updated, false otherwise

getReturnDescription

@Nullable
public java.lang.String getReturnDescription()

Gets the description of the return value

Returns:

A description of the return value

getNonNullReturnDescription

@NotNull
public java.lang.String getNonNullReturnDescription()

Gets the description of the return value, or if null returns a non-null string

Returns:

A description of the return value, or if null returns a non-null string

equals

public boolean equals(@Nullable
                      java.lang.Object other)

Overrides:

equals in class ParameterizedDocumentation