Javadoc for default methods of an interface
Brian Goetz
brian.goetz at oracle.com
Wed Feb 5 11:42:34 PST 2014
There are some new javadoc tags to let you separate normative from
non-normative, and how it applies separately to the interface vs the
default implementation. They are:
@implSpec -- *specification* about what the default implementation does,
such as "the default implementation throws UOE". This can be counted on
by subclasses to make decisions about "should I override this or not".
@implNote -- non-normative notes about the implementation, which
historically have been prefaced by "implementation note".
@apiNote -- non-normative notes about the API, such as examples of how
to use it.
The fourth quadrant, normative spec about the interface, needs no tag
since that's what the spec is for.
On 2/5/2014 12:42 PM, Behrooz N wrote:
> Hi,
>
> I was wondering if there is a way to specify the "default" value returned
> by a defender method of an interface that would be processed specifically
> by javadoc of Java 8? And, how fair this expectation is or what is the
> argument not to have it?
>
> Thanks in advance,
> Behrooz
>
More information about the jdk8-dev
mailing list