Java: Common Annotation for "Not Yet Implemented"

Question

Is there a common or standard annotation in Java for methods that, while defined, have yet to be implemented?

So that, for instance, if I were using a pre-alpha version of a library that contained something like

@NotImplementedYet public void awesomeMethodThatTotallyDoesExactlyWhatYouNeed(){ /* TODO */ }

I'd get a compile-time warning when trying to call awesomeMethodThatTotallyDoesExactlyWhatYouNeed?

Most libraries simply won't expose that method at all. What would be the point? — Louis Wasserman
– Louis Wasserman, Commented Apr 2, 2012 at 21:49
I've encountered it, as a user. Maybe to float the future API as an idea, get users ready for it? — rampion
– rampion, Commented Apr 2, 2012 at 21:51
You could, of course, create your own "@NotImplementedYet" annotation, and use it however you want: docs.oracle.com/javase/1.5.0/docs/guide/language/… — paulsm4
– paulsm4, Commented Apr 2, 2012 at 21:54
Related: Is there anything like .NET's NotImplementedException in Java? — Basil Bourque
– Basil Bourque, Commented Feb 23, 2019 at 3:02

Alexander · Accepted Answer · 2012-04-02 21:58:37Z

19

You might want to use UnsupportedOperationException and detect calls to-yet-to-be-implemented methods when running your tests.

answered Apr 2, 2012 at 21:58

Alexander

23.5k11 gold badges65 silver badges74 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Miserable Variable Over a year ago

OP is looking for an annotation that will tell the caller at compile time that the method will throw UnsupportedOperationException. As other side creating such an annotation is easy, he is looking for something that is accepted as convention

bbarker Over a year ago

Not exactly the solution requested but better than nothing, and somewhat orthogonal (better in other ways).

Jens Bannmann · Accepted Answer · 2019-03-10 08:17:10Z

No, there is no standard annotation specifically for methods that have yet to be implemented.

However, there is a more general annotation in the JDK that marks an API which developers are discouraged from using, and the Java compiler itself can issue warnings when it is used. I am talking about @Deprecated, which many developers only think of as "announcing removal". However, the relevant articles in the JDK docs (e.g. for Java 7 and Java 9) list several example use cases, only one of them being about removal:

The API is dangerous (for example, the Thread.stop method).

There is a simple rename (for example, AWT Component.show/hide replaced by setVisible).

A newer, better API can be used instead.

The deprecated API is going to be removed.

I think your case "not implemented yet" certainly goes in the same direction as those. Further, if the method would always throw a NotYetImplementedException, it even fits the example "The API is dangerous".

So all you need to do is the following:

Add @Deprecated to the method
Add @deprecated Javadoc to explain the background
Configure your build to invoke the compiler with -Xlint:deprecation so that it issues warnings.

mhradek · Accepted Answer · 2017-05-01 22:58:41Z

You could create your own annotation. With the runtime retention policy you can then configure target builds to know to look for this annotation, if necessary.

import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD}) @Retention(RetentionPolicy.RUNTIME) public @interface Unimplemented { boolean value() default true; }

Andrejs · Accepted Answer · 2012-04-02 21:59:37Z

Google guava libraries use the @Beta annotations for API that is likely to change but the methods are implemented though

Collectives™ on Stack Overflow

Java: Common Annotation for "Not Yet Implemented"

4 Answers 4

2 Comments

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

Comments

Comments

Comments

Linked

Related