com.screenscraper.view.languagesupport.javadoc

Class Documentation

java.lang.Object

com.screenscraper.view.languagesupport.javadoc.Documentation

Direct Known Subclasses:

ClassDocumentation, ParameterizedDocumentation, ThrownExceptionDocumentation, VariableDocumentation

public abstract class Documentation
extends java.lang.Object

Class Description

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	deprecated
protected java.lang.String	description
protected java.lang.String	name
protected java.lang.String	type
protected java.lang.Class<?>	typeClass

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Documentation(java.lang.Class<?> typeClass, java.lang.String type, java.lang.String name, java.lang.String description) Create a documentation object with the given type, name, and description

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getDescription() Returns the description of the documented object
java.lang.String	getName() Returns the name of the documented object
java.lang.String	getNonNullDescription() Returns the description of the documented object (or empty string if we have none)
java.lang.String	getType() Returns the type of the documented object
java.lang.Class<?>	getTypeClass() Returns the type of the object as a class, if known, or null otherwise
int	hashCode()
boolean	isDeprecated() Returns whether this item is marked as deprecated
void	setDeprecated(boolean deprecated) Sets whether of not this is deprecated
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

@NotNull
protected java.lang.String name

type

@NotNull
protected java.lang.String type

typeClass

@Nullable
protected java.lang.Class<?> typeClass

description

@Nullable
protected java.lang.String description

deprecated

protected boolean deprecated

Constructor Detail

Documentation

protected Documentation(@Nullable
                        java.lang.Class<?> typeClass,
                        @NotNull
                        java.lang.String type,
                        @NotNull
                        java.lang.String name,
                        @Nullable
                        java.lang.String description)

Create a documentation object with the given type, name, and description

Parameters:

typeClass - The actual class of the documented object if known

type - The type of the object this documents

name - The name of the object this documents

description - A description of the object this documents (as HTML)

Method Detail

getName

@NotNull
public java.lang.String getName()

Returns the name of the documented object

Returns:

The name fo the documented object

getType

@NotNull
public java.lang.String getType()

Returns the type of the documented object

Returns:

The type of the documented object

getTypeClass

@Nullable
public java.lang.Class<?> getTypeClass()

Returns the type of the object as a class, if known, or null otherwise

Returns:

The type of the object as a class, if known, or null otherwise

getDescription

@Nullable
public java.lang.String getDescription()

Returns the description of the documented object

Returns:

A description of the documented object

getNonNullDescription

@NotNull
public java.lang.String getNonNullDescription()

Returns the description of the documented object (or empty string if we have none)

Returns:

A description of the documented object

setDeprecated

public void setDeprecated(boolean deprecated)

Sets whether of not this is deprecated

Parameters:

deprecated - Whether or not this is deprecated

isDeprecated

public boolean isDeprecated()

Returns whether this item is marked as deprecated

Returns:

True if the item is deprecated, false if it isn't

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object