com.screenscraper.view.languagesupport.javadoc

Class VariableDocumentation

java.lang.Object

com.screenscraper.view.languagesupport.javadoc.Documentation

com.screenscraper.view.languagesupport.javadoc.VariableDocumentation

public class VariableDocumentation
extends Documentation

Class Description

Version:

1.0

Field Summary

Fields

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

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

deprecated, description, name, type, typeClass

Constructor Summary

Constructors

Constructor and Description
VariableDocumentation(java.lang.Class<?> typeClass, java.lang.String type, java.lang.String name, java.lang.String description, java.lang.reflect.Parameter parameter, java.lang.reflect.Field field) Creates documentation for a variable
VariableDocumentation(java.lang.Class<?> typeClass, java.lang.String type, java.lang.String name, java.lang.String description, java.lang.reflect.Parameter parameter, java.lang.reflect.Field field, java.lang.String value) Creates documentation for a variable

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
java.lang.reflect.Field	getField() Returns the documented field, or null if unknown
java.lang.reflect.Parameter	getParameter() Returns the documented parameter, or null if unknown
java.lang.String	getValue() Returns the value stored in this variable, or null if it is unknown.
boolean	setField(java.lang.reflect.Field field) Sets the documented field.
boolean	setParameter(java.lang.reflect.Parameter parameter) Sets the documented parameter.

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

getDescription, getName, getNonNullDescription, getType, getTypeClass, hashCode, 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 VariableDocumentation NULL

Null object for the class

Constructor Detail

VariableDocumentation

public VariableDocumentation(@Nullable
                             java.lang.Class<?> typeClass,
                             @NotNull
                             java.lang.String type,
                             @NotNull
                             java.lang.String name,
                             @Nullable
                             java.lang.String description,
                             @Nullable
                             java.lang.reflect.Parameter parameter,
                             @Nullable
                             java.lang.reflect.Field field)

Creates documentation for a variable

Parameters:

typeClass - The actual class of the variable if known

type - The type of the variable

name - The declared name of the variable

parameter - The parameter this documents

field - The field this documents

description - A description of this variable

VariableDocumentation

public VariableDocumentation(@Nullable
                             java.lang.Class<?> typeClass,
                             @NotNull
                             java.lang.String type,
                             @NotNull
                             java.lang.String name,
                             @Nullable
                             java.lang.String description,
                             @Nullable
                             java.lang.reflect.Parameter parameter,
                             @Nullable
                             java.lang.reflect.Field field,
                             @Nullable
                             java.lang.String value)

Creates documentation for a variable

Parameters:

typeClass - The actual class of the variable if known

type - The type of the variable

name - The declared name of the variable

description - A description of this variable

parameter - The parameter this documents

field - The field this documents

value - The value held in this variable. Useful for constant values

Method Detail

getParameter

@Nullable
public java.lang.reflect.Parameter getParameter()

Returns the documented parameter, or null if unknown

Returns:

The documented parameter, or null if unknown

setParameter

public boolean setParameter(@Nullable
                            java.lang.reflect.Parameter parameter)

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

Parameters:

parameter - The documented parameter

Returns:

True if the value was updated, false otherwise

getField

@Nullable
public java.lang.reflect.Field getField()

Returns the documented field, or null if unknown

Returns:

The documented field, or null if unknown

setField

public boolean setField(@Nullable
                        java.lang.reflect.Field field)

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

Parameters:

field - The documented field

Returns:

True if the value was updated, false otherwise

getValue

@Nullable
public java.lang.String getValue()

Returns the value stored in this variable, or null if it is unknown. This should only be used for constant value variables

Returns:

The value stored in this variable

equals

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

Overrides:

equals in class Documentation