com.github.therapi.runtimejavadoc

Class BaseJavadoc

java.lang.Object

com.github.therapi.runtimejavadoc.BaseJavadoc

Direct Known Subclasses:

ClassJavadoc, FieldJavadoc, MethodJavadoc

public abstract class BaseJavadoc
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
Comment	getComment()
java.lang.String	getName()
java.util.List<OtherJavadoc>	getOther()
java.util.List<SeeAlsoJavadoc>	getSeeAlso()
boolean	isEmpty()
boolean	isPresent() Deprecated. use !isEmpty() instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

getComment

public Comment getComment()

getSeeAlso

public java.util.List<SeeAlsoJavadoc> getSeeAlso()

getOther

public java.util.List<OtherJavadoc> getOther()

isEmpty

public boolean isEmpty()

Returns:

false if this object has content, or true if it represents absent Javadoc.

isPresent

@Deprecated
public boolean isPresent()

Deprecated. use !isEmpty() instead

Returns:

true if this object has content, or false if it represents absent Javadoc.