1.0.0

Этот крупный выпуск первый.

Подробнее о выпуске: https://github.com/Bloogefest/BF.Annotation/commits/1.0.0

Maven

<repository>
  <id>central</id>
  <name>Maven Central</name>
  <url>https://repo1.maven.org/maven2</url>
</repository>

<dependency>
  <groupId>com.bloogefest</groupId>
  <artifactId>annotation</artifactId>
  <version>1.0.0</version>
</dependency>

Gradle

repositories {
    mavenCentral()
}

dependencies {
    implementation("com.bloogefest:annotation:1.0.0")
}

Введено:

Аннотации:

• Contract

Аннотация контракта метода или конструктора.

API Note: Наличие этой аннотации говорит о том, что поведение метода или конструктора соответствует значению контракта.

@Contract("!null -> _; null -> fail")
boolean isEmpty(final @Nullable String string) throws NullPointerException {
    return string.length() == 0;
}

• Contract::value()

Возвращает значение контракта.

Returns: Значение контракта.

final Contract contract = () -> "_ -> _";
System.out.println(contract.value());

• Contract::pure()

Возвращает значение чистоты контракта.

Returns: Значение чистоты контракта.

final Contract contract = () -> "_ -> _";
System.out.println(contract.pure());

• Experimental

Аннотация чего-то экспериментального.

API Note: Наличие этой аннотации у чего-то говорит о том, что оно ещё в разработке и может быть переименовано, перемещено или вовсе удалено.

@Experimental
@Contract("_ -> _")
boolean isEmpty(final @NotNull String string) throws NullPointerException {
    return string.length() == 0;
}

• Nls

Аннотация того, что должно быть локализовано.

API Note: Наличие этой аннотации у чего-то говорит о том, что оно должно быть локализовано.

@Contract("_ -> _")
boolean isEmpty(final @Nls @NotNull String string) throws NullPointerException {
    return string.length() == 0;
}

• NotNls

Аннотация того, что не должно быть локализовано.

API Note: Наличие этой аннотации у чего-то говорит о том, что оно не должно быть локализовано.

@Contract("_ -> _")
boolean isEmpty(final @NotNls @NotNull String string) throws NullPointerException {
    return string.length() == 0;
}

• NotNull

Аннотация ненулевого значения.

API Note: Наличие этой аннотации говорит о том, что значение не должно быть нулевым.

@Contract("_ -> _")
boolean isEmpty(final @NotNull String string) throws NullPointerException {
    return string.length() == 0;
}

• Null

Аннотация нулевого значения.

API Note: Наличие этой аннотации говорит о том, что значение должно быть нулевым.

@Contract("_ -> fail")
boolean isEmpty(final @Null String string) throws NullPointerException {
    return string.length() == 0;
}

• Nullable

Аннотация обнуляемого значения.

API Note: Наличие этой аннотации говорит о том, что значение может быть нулевым.

@Contract("!null -> _; null -> fail")
boolean isEmpty(final @Nullable String string) throws NullPointerException {
    return string.length() == 0;
}

• Obsolete

Аннотация чего-то устаревшего.

API Note: Наличие этой аннотации у чего-то говорит о том, что оно устарело, не рекомендуется к использованию и может быть удалено.

@Obsolete
@Contract("_ -> _")
boolean isEmpty(final @NotNull String string) throws NullPointerException {
    return string.length() == 0;
}

• Obsolete::value()

Содержит полный путь до альтернативы, которая хотя бы немного заменяет это.

Returns: Полный путь до альтернативы, которая хотя бы немного заменяет это.

final Obsolete obsolete = () -> "com.bloogefest.annotation.analysis.Experimental";
System.out.println(obsolete.value());