Типови Јава напомена

У овом упутству ћемо научити о различитим типовима Јава напомена уз помоћ примера.

Јава напомене су метаподаци (подаци о подацима) за наш изворни код програма. Јава СЕ нуди неколико предефинисаних напомена. Штавише, такође можемо креирати прилагођене напомене према нашим потребама.

Ако не знате шта су напомене, посетите упутство за Јава напомене.

Ове напомене се могу категорисати као:

1. Унапред дефинисане напомене

  • @Deprecated
  • @Override
  • @SuppressWarnings
  • @SafeVarargs
  • @FunctionalInterface

2. Прилагођене напомене

3. Мета-напомене

  • @Retention
  • @Documented
  • @Target
  • @Inherited
  • @Repeatable

Унапред дефинисани типови напомена

1. @Депрецатед

@DeprecatedНапомена је маркер напомена која показује елемент (класа, метод, поље, итд) ис депрецатед и замењен новијим елемент.

Његова синтакса је:

 @Deprecated accessModifier returnType deprecatedMethodName() (… )

Када програм користи елемент који је проглашен застарелим, компајлер генерише упозорење.

Јавадоц @deprecatedознаку користимо за документовање застарјелог елемента.

 /** * @deprecated * why it was deprecated */ @Deprecated accessModifier returnType deprecatedMethodName() (… )

Пример 1: Пример застареле напомене

 class Main ( /** * @deprecated * This method is deprecated and has been replaced by newMethod() */ @Deprecated public static void deprecatedMethod() ( System.out.println("Deprecated method"); ) public static void main(String args()) ( deprecatedMethod(); ) )

Оутпут

 Застарела метода

2. @ Оверриде

У @Overrideнапомена наводи да начин на подгрупе замењује методу суперкласна са истим именом метода, врсте повратка, и листа параметара.

Није обавезно користити @Overrideприликом замене методе. Међутим, ако га користимо, компајлер даје грешку ако нешто није у реду (као што је погрешан тип параметра) док надјачава методу.

Пример 2: Пример замене @ Оверриде

 class Animal ( // overridden method public void display()( System.out.println("I am an animal"); ) ) class Dog extends Animal ( // overriding method @Override public void display()( System.out.println("I am a dog"); ) public void printMessage()( display(); ) ) class Main ( public static void main(String() args) ( Dog dog1 = new Dog(); dog1.printMessage(); ) )

Оутпут 

 Ја сам пас

У овом примеру, израдом објекта дог1 класе Дог, можемо позвати његову методу принтМессаге () која затим извршава display()израз.

Будући да display()је дефинисан у обе класе, метода поткласе Дог надјачава методу суперкласе Анимал. Дакле, display()назива се подкласа.

3. @СуппрессВарнингс

Као што и само име говори, @SuppressWarningsнапомена налаже компајлеру да сузбије упозорења која се генеришу док се програм извршава.

Можемо одредити врсту упозорења која треба сузбити. Упозорења која се могу сузбити су специфична за компајлер, али постоје две категорије упозорења: застаревање и неозначено .

Да бисмо сузбили одређену категорију упозорења, користимо:

 @SuppressWarnings("warningCategory")

На пример,

 @SuppressWarnings("deprecated")

Да бисмо сузбили више категорија упозорења, користимо:

 @SuppressWarnings(("warningCategory1", "warningCategory2"))

На пример,

 @SuppressWarnings(("deprecated", "unchecked"))

Категорија deprecatedналаже компајлеру да сузбије упозорења када користимо застарели елемент.

Категорија uncheckedналаже компајлеру да сузбије упозорења када користимо сирове типове.

Недефинисана упозорења се игноришу. На пример,

 @SuppressWarnings("someundefinedwarning")

Пример 3: Пример напомене @СуппрессВарнингс

 class Main ( @Deprecated public static void deprecatedMethod() ( System.out.println("Deprecated method"); ) @SuppressWarnings("deprecated") public static void main(String args()) ( Main depObj = new Main(); depObj. deprecatedMethod(); ) )

Оутпут 

 Застарела метода

Овде deprecatedMethod()је означено као застарело и даће упозорења компајлеру када се користи. Коришћењем @SuppressWarnings("deprecated")напомене можемо избећи упозорења компајлера.

4. @SafeVarargs

The @SafeVarargs annotation asserts that the annotated method or constructor does not perform unsafe operations on its varargs (variable number of arguments).

We can only use this annotation on methods or constructors that cannot be overridden. This is because the methods that override them might perform unsafe operations.

Before Java 9, we could use this annotation only on final or static methods because they cannot be overridden. We can now use this annotation for private methods as well.

Example 4: @SafeVarargs annotation example

 import java.util.*; class Main ( private void displayList(List… lists) ( for (List list : lists) ( System.out.println(list); ) ) public static void main(String args()) ( Main obj = new Main(); List universityList = Arrays.asList("Tribhuvan University", "Kathmandu University"); obj.displayList(universityList); List programmingLanguages = Arrays.asList("Java", "C"); obj.displayList(universityList, programmingLanguages); ) )

Warnings 

 Type safety: Potential heap pollution via varargs parameter lists Type safety: A generic array of List is created for a varargs parameter

Output

 Note: Main.java uses unchecked or unsafe operations. (Tribhuvan University, Kathmandu University) (Tribhuvan University, Kathmandu University) (Java, C)

Here, List … lists specifies a variable-length argument of type List. This means that the method displayList() can have zero or more arguments.

The above program compiles without errors but gives warnings when @SafeVarargs annotation isn't used.

When we use @SafeVarargs annotation in the above example,

 @SafeVarargs private void displayList(List… lists) (… )

We get the same output but without any warnings. Unchecked warnings are also suppressed when we use this annotation.

5. @FunctionalInterface

Java 8 first introduced this @FunctionalInterface annotation. This annotation indicates that the type declaration on which it is used is a functional interface. A functional interface can have only one abstract method.

Example 5: @FunctionalInterface annotation example

 @FunctionalInterface public interface MyFuncInterface( public void firstMethod(); // this is an abstract method )

If we add another abstract method, let's say

 @FunctionalInterface public interface MyFuncInterface( public void firstMethod(); // this is an abstract method public void secondMethod(); // this throws compile error )

Now, when we run the program, we will get the following warning:

 Unexpected @FunctionalInterface annotation @FunctionalInterface MyFuncInterface is not a functional interface multiple non-overriding abstract methods found in interface MyFuncInterface

It is not mandatory to use @FunctionalInterface annotation. The compiler will consider any interface that meets the functional interface definition as a functional interface.

We use this annotation to make sure that the functional interface has only one abstract method.

However, it can have any number of default and static methods because they have an implementation.

 @FunctionalInterface public interface MyFuncInterface( public void firstMethod(); // this is an abstract method default void secondMethod() (… ) default void thirdMethod() (… ) )

Custom Annotations

It is also possible to create our own custom annotations.

Its syntax is:

 (Access Specifier) @interface ( DataType () (default value); )

Here is what you need to know about custom annotation:

  • Annotations can be created by using @interface followed by the annotation name.
  • The annotation can have elements that look like methods but they do not have an implementation.
  • The default value is optional. The parameters cannot have a null value.
  • The return type of the method can be primitive, enum, string, class name or array of these types.

Example 6: Custom annotation example

 @interface MyCustomAnnotation ( String value() default "default value"; ) class Main ( @MyCustomAnnotation(value = "programiz") public void method1() ( System.out.println("Test method 1"); ) public static void main(String() args) throws Exception ( Main obj = new Main(); obj.method1(); ) )

Output 

 Test method 1

Meta Annotations

Meta-annotations are annotations that are applied to other annotations.

1. @Retention

The @Retention annotation specifies the level up to which the annotation will be available.

Its syntax is:

 @Retention(RetentionPolicy)

There are 3 types of retention policies:

  • RetentionPolicy.SOURCE - The annotation is available only at the source level and is ignored by the compiler.
  • RetentionPolicy.CLASS - The annotation is available to the compiler at compile-time, but is ignored by the Java Virtual Machine (JVM).
  • RetentionPolicy.RUNTIME - The annotation is available to the JVM.

For example,

 @Retention(RetentionPolicy.RUNTIME) public @interface MyCustomAnnotation(… )

2. @Documented

By default, custom annotations are not included in the official Java documentation. To include our annotation in the Javadoc documentation, we use the @Documented annotation.

For example,

 @Documented public @interface MyCustomAnnotation(… )

3. @Target

We can restrict an annotation to be applied to specific targets using the @Target annotation.

Its syntax is:

 @Target(ElementType)

The ElementType can have one of the following types:

Element Type Target
ElementType.ANNOTATION_TYPE Annotation type
ElementType.CONSTRUCTOR Constructors
ElementType.FIELD Fields
ElementType.LOCAL_VARIABLE Local variables
ElementType.METHOD Methods
ElementType.PACKAGE Package
ElementType.PARAMETER Parameter
ElementType.TYPE Any element of class

For example,

 @Target(ElementType.METHOD) public @interface MyCustomAnnotation(… )

In this example, we have restricted the use of this annotation to methods only.

Note: If the target type is not defined, the annotation can be used for any element.

4. @Inherited

By default, an annotation type cannot be inherited from a superclass. However, if we need to inherit an annotation from a superclass to a subclass, we use the @Inherited annotation.

Its syntax is:

 @Inherited

For example,

 @Inherited public @interface MyCustomAnnotation (… ) @MyCustomAnnotation public class ParentClass(… ) public class ChildClass extends ParentClass (… )

5. @Repeatable

An annotation that has been marked by @Repeatable can be applied multiple times to the same declaration.

 @Repeatable(Universities.class) public @interface University ( String name(); )

Вредност дефинисана у @Repeatableнапомени је напомена контејнера. Напомена контејнера има променљиву вредност типа низа горе наведене поновљиве напомене. Овде Universitiesсе налазе типови напомена који садрже.

 public @interface Universities ( University() value(); )

Сада се @Universityнапомена може користити више пута на истој декларацији.

 @University(name = "TU") @University(name = "KU") private String uniName;

Ако треба да преузмемо податке о напоменама, можемо да користимо Рефлецтион АПИ.

Да бисмо преузели вредности напомена, користимо метод getAnnotationsByType()или getAnnotations()метод дефинисан у Рефлецтион АПИ.

Занимљиви Чланци...