com.screenscraper.view.languagesupport.javadoc

Class ThrownExceptionDocumentation

java.lang.Object

com.screenscraper.view.languagesupport.javadoc.Documentation

com.screenscraper.view.languagesupport.javadoc.ThrownExceptionDocumentation

public class ThrownExceptionDocumentation
extends Documentation

Class Description

Version:

1.0

Field Summary

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

deprecated, description, name, type, typeClass

Constructor Summary

Constructors

Constructor and Description
ThrownExceptionDocumentation(java.lang.String name, java.lang.String description) Creates documentation for an exception that is thrown
ThrownExceptionDocumentation(java.lang.String type, java.lang.String name, java.lang.String description) Creates documentation for an exception that is thrown

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)

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

Constructor Detail

ThrownExceptionDocumentation

public ThrownExceptionDocumentation(@NotNull
                                    java.lang.String name,
                                    @Nullable
                                    java.lang.String description)

Creates documentation for an exception that is thrown

Parameters:

name - The name of the exception

description - A description of when it is thrown

ThrownExceptionDocumentation

public ThrownExceptionDocumentation(@NotNull
                                    java.lang.String type,
                                    @NotNull
                                    java.lang.String name,
                                    @Nullable
                                    java.lang.String description)

Creates documentation for an exception that is thrown

Parameters:

name - The name of the exception

type - The type of the exception. This should match the name in most cases

description - A description of when it is thrown

Method Detail

equals

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

Overrides:

equals in class Documentation