Releases · Bloogefest/BF.Annotation

15 Nov 18:50

3.0.0

55e35c1

3.0.0 Latest

Latest

Этот выпуск несовместим с предыдущим — все аннотации были переработаны, а некоторые даже удалены. Например, аннотация Removal была удалена и заменена новым параметром Obsolete::to() в уже существующей аннотации Obsolete. Аннотации: Enumed, Magical, Nls, NotNls — показались довольно бесполезными, поэтому тоже были удалены.

Подробнее об изменениях: 2.1.0...3.0.0

Maven

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

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

Gradle

mavenCentral()

implementation("com.bloogefest:annotation:3.0.0")

Введено:

Аннотации:

Contract::impact()

Возвращает тип влияния на окружение метода или конструктора.

API Note: Этот параметр был введён в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Requirements: Реализация этого параметра по умолчанию является эталонной, так как она полностью следует спецификации.
Implementation Note: Для того чтобы применение этого параметра было максимально эффективно, следуйте рекомендациям по применению.

public final class Singleton {

    private static volatile @Nullable Singleton defaultInstance;
    
    private Singleton() {}

    @Contract(value = "-> !null", impact = Contract.Impact.INTERNAL)
    public static @NonNull Singleton defaultInstance() {
        if (defaultInstance == null) synchronized (Singleton.class) {
            if (defaultInstance == null) defaultInstance = new Singleton();
        }
        return defaultInstance;
    }

}

Contract.Impact

Типы влияния на окружение.

API Note: Это перечисление было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Requirements: Реализация этого перечисления по умолчанию является эталонной, так как она полностью следует спецификации.
Implementation Note: Для того чтобы применение этого перечисления было максимально эффективно, следуйте рекомендациям по применению.

public final class Singleton {

    private static volatile @Nullable Singleton defaultInstance;
    
    private Singleton() {}

    @Contract(value = "-> !null", impact = Contract.Impact.INTERNAL)
    public static @NonNull Singleton defaultInstance() {
        if (defaultInstance == null) synchronized (Singleton.class) {
            if (defaultInstance == null) defaultInstance = new Singleton();
        }
        return defaultInstance;
    }

}

Contract.Impact.NONE

Отсутствие влияния на окружение.

API Note: Это значение было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Note: Для того чтобы применение этого значения было максимально эффективно, следуйте рекомендациям по применению.

public final class Holder<T> {

    private final @Nullable T object;

    public Holder(final @Nullable T object) {
        this.object = object;
    }

    @Contract(value = "-> ~", impact = Contract.Impact.NONE)
    public @Nullable T object() {
        return object;
    }

}

Contract.Impact.SHARED

Влияние на внутреннее и внешнее окружение.

API Note: Это значение было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Note: Для того чтобы применение этого значения было максимально эффективно, следуйте рекомендациям по применению.

public final class Listener {

    private volatile boolean listened;

    public Listener() {}

    @Contract(value = "-> ~", impact = Contract.Impact.SHARED)
    public void listen() {
        if (!listened) synchronized (this) {
            if (!listened) {
                listened = true;
                return;
            }
        }
        System.exit(0);
    }

    @Contract(value = "-> ~", impact = Contract.Impact.NONE)
    public boolean listened() {
        return listened;
    }

}

Contract.Impact.INTERNAL

Влияние на внутреннее окружение.

API Note: Это значение было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Note: Для того чтобы применение этого значения было максимально эффективно, следуйте рекомендациям по применению.

public final class Singleton {

    private static volatile @Nullable Singleton defaultInstance;
    
    private Singleton() {}

    @Contract(value = "-> !null", impact = Contract.Impact.INTERNAL)
    public static @NonNull Singleton defaultInstance() {
        if (defaultInstance == null) synchronized (Singleton.class) {
            if (defaultInstance == null) defaultInstance = new Singleton();
        }
        return defaultInstance;
    }

}

Contract.Impact.EXTERNAL

Влияние на внешнее окружение.

API Note: Это значение было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Note: Для того чтобы применение этого значения было максимально эффективно, следуйте рекомендациям по применению.

public final class Listener {

    public Listener() {}

    @Contract(value = "-> ~", impact = Contract.Impact.EXTERNAL)
    public void listen() {
        System.exit(0);
    }

}

Contract.Impact.UNDEFINED

Неопределённое влияние на окружение.

API Note: Это значение было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Note: Для того чтобы применение этого значения было максимально эффективно, следуйте рекомендациям по применению.

@FunctionalInterface
public interface Listener {

    @Contract(value = "-> ?", impact = Contract.Impact.UNDEFINED)
    void listen();

}

Experimental::from()

Возвращает идентификатор выпуска, выпуск-кандидата или снимка, в котором состояние элемента было обозначено как экспериментальное.

API Note: Этот параметр был введён в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Requirements: Реализация этого параметра по умолчанию является эталонной, так как она полностью следует спецификации.
Implementation Note: Для того чтобы применение этого параметра было максимально эффективно, следуйте рекомендациям по применению.

@Experimental(from = "3.7.4-RC1", to = "3.7.4-RC2")
@FunctionalInterface
public interface Worker {

    @Experimental(from = "3.7.4-RC2", to = "3.7.4-RC3")
    @Contract("-> ?")
    void work();

}

Experimental::to()

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

Assets 5

15 Nov 13:41

Bloogefest

3.0.0-RC2

849ab67

3.0.0-RC2 Pre-release

Pre-release

Этот предварительный выпуск совместим с предыдущим предварительным.

Подробнее о релизе: 3.0.0-RC1...3.0.0-RC2

Maven

<repository>
  <id>ossrh-rc</id>
  <url>https://s01.oss.sonatype.org/content/repositories/releases/</url>
</repository>

<dependency>
  <groupId>com.bloogefest</groupId>
  <artifactId>annotation</artifactId>
  <version>3.0.0-RC2</version>
</dependency>

Gradle

maven("https://s01.oss.sonatype.org/content/repositories/releases/")

implementation("com.bloogefest:annotation:3.0.0-RC2")

Изменено:

Аннотации:

Contract::impact()

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

Contract.Impact

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

Contract.Impact.NONE

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

Contract.Impact.SHARED

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

Contract.Impact.INTERNAL

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

Contract.Impact.EXTERNAL

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

Contract.Impact.UNDEFINED

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

Experimental::from()

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

Experimental::to()

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

Obsolete::from()

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

Obsolete::to()

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

Assets 5

14 Nov 21:48

Bloogefest

3.0.0-RC1

e73d150

3.0.0-RC1 Pre-release

Pre-release

Этот предварительный выпуск несовместим с предыдущим стабильным.

Подробнее о релизе: 2.1.0...3.0.0-RC1

Maven

<repository>
  <id>ossrh-rc</id>
  <url>https://s01.oss.sonatype.org/content/repositories/releases/</url>
</repository>

<dependency>
  <groupId>com.bloogefest</groupId>
  <artifactId>annotation</artifactId>
  <version>3.0.0-RC1</version>
</dependency>

Gradle

maven("https://s01.oss.sonatype.org/content/repositories/releases/")

implementation("com.bloogefest:annotation:3.0.0-RC1")

Введено:

Аннотации:

Contract::impact()

Возвращает тип влияния на окружение метода или конструктора.

API Note: Этот параметр был введён в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Requirements: Реализация этого параметра по умолчанию является эталонной, так как она полностью следует спецификации.
Implementation Note: Для того чтобы применение этого параметра было максимально эффективно, следуйте рекомендациям по применению.

public final class Singleton {

    private static volatile @Nullable Singleton defaultInstance;
    
    private Singleton() {}

    @Contract(value = "-> !null", impact = Contract.Impact.INTERNAL)
    public static @NonNull Singleton defaultInstance() {
        if (defaultInstance == null) synchronized (Singleton.class) {
            if (defaultInstance == null) defaultInstance = new Singleton();
        }
        return defaultInstance;
    }

}

Contract.Impact

Типы влияния на окружение.

API Note: Это перечисление было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Requirements: Реализация этого перечисления по умолчанию является эталонной, так как она полностью следует спецификации.
Implementation Note: Для того чтобы применение этого перечисления было максимально эффективно, следуйте рекомендациям по применению.

public final class Singleton {

    private static volatile @Nullable Singleton defaultInstance;
    
    private Singleton() {}

    @Contract(value = "-> !null", impact = Contract.Impact.INTERNAL)
    public static @NonNull Singleton defaultInstance() {
        if (defaultInstance == null) synchronized (Singleton.class) {
            if (defaultInstance == null) defaultInstance = new Singleton();
        }
        return defaultInstance;
    }

}

Contract.Impact.NONE

Отсутствие влияния на окружение.

API Note: Это значение было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Note: Для того чтобы применение этого значения было максимально эффективно, следуйте рекомендациям по применению.

public final class Holder<T> {

    private final @Nullable T object;

    public Holder(final @Nullable T object) {
        this.object = object;
    }

    @Contract(value = "-> ~", impact = Contract.Impact.NONE)
    public @Nullable T object() {
        return object;
    }

}

Contract.Impact.SHARED

Влияние на внутреннее и внешнее окружение.

API Note: Это значение было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Note: Для того чтобы применение этого значения было максимально эффективно, следуйте рекомендациям по применению.

public final class Listener {

    private volatile boolean listened;

    public Listener() {}

    @Contract(value = "-> ~", impact = Contract.Impact.SHARED)
    public void listen() {
        if (!listened) synchronized (this) {
            if (!listened) {
                listened = true;
                return;
            }
        }
        System.exit(0);
    }

    @Contract(value = "-> ~", impact = Contract.Impact.NONE)
    public boolean listened() {
        return listened;
    }

}

Contract.Impact.INTERNAL

Влияние на внутреннее окружение.

API Note: Это значение было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Note: Для того чтобы применение этого значения было максимально эффективно, следуйте рекомендациям по применению.

public final class Singleton {

    private static volatile @Nullable Singleton defaultInstance;
    
    private Singleton() {}

    @Contract(value = "-> !null", impact = Contract.Impact.INTERNAL)
    public static @NonNull Singleton defaultInstance() {
        if (defaultInstance == null) synchronized (Singleton.class) {
            if (defaultInstance == null) defaultInstance = new Singleton();
        }
        return defaultInstance;
    }

}

Contract.Impact.EXTERNAL

Влияние на внешнее окружение.

API Note: Это значение было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Note: Для того чтобы применение этого значения было максимально эффективно, следуйте рекомендациям по применению.

public final class Listener {

    public Listener() {}

    @Contract(value = "-> ~", impact = Contract.Impact.EXTERNAL)
    public void listen() {
        System.exit(0);
    }

}

Contract.Impact.UNDEFINED

Неопределённое влияние на окружение.

API Note: Это значение было введено в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Note: Для того чтобы применение этого значения было максимально эффективно, следуйте рекомендациям по применению.

@FunctionalInterface
public interface Listener {

    @Contract(value = "-> ?", impact = Contract.Impact.UNDEFINED)
    void listen();

}

Experimental::from()

Возвращает идентификатор выпуска, выпуск-кандидата или снимка, в котором состояние элемента было обозначено как экспериментальное.

API Note: Этот параметр был введён в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Requirements: Реализация этого параметра по умолчанию является эталонной, так как она полностью следует спецификации.
Implementation Note: Для того чтобы применение этого параметра было максимально эффективно, следуйте рекомендациям по применению.

@Experimental(from = "3.7.4-RC1", to = "3.7.4-RC2")
@FunctionalInterface
public interface Worker {

    @Experimental(from = "3.7.4-RC2", to = "3.7.4-RC3")
    @Contract("-> ?")
    void work();

}

Experimental::to()

Возвращает идентификатор выпуска, выпуск-кандидата или снимка, в котором планируется, что состояние элемента перестанет быть обозначенным как экспериментальное.

API Note: Этот параметр был введён в выпуск-кандидате 3.0.0-RC1, после чего планируется допускать лишь небольшие изменения в его документации.
Implementation Requirements: Реализация этого параметра по умолчанию является эталонной, так как она полностью следует спецификации.
Implementation Note: Для того чтобы применение этого параметра было максимально эффективно, следуйте рекомендациям по применению.

@Experimental(from = "3.7.4-RC1", to = "3.7.4-RC2")
@FunctionalInterface
public interface Worker {

    @Experimental(from = "3.7.4-RC2", to = "3.7.4-RC3")
    @Contract("-> ?")
    void work();

}

[`Obsolete::fro...

Assets 5

04 Jun 10:57

Bloogefest

2.1.0

19d0270

2.1.0

Этот стабильный выпуск совместим с предыдущим.

Подробнее о релизе: 2.0.0...2.1.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>2.1.0</version>
</dependency>

Gradle

repositories {
    mavenCentral()
}

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

Введено:

Аннотации:

Enumed

Перечисление значений.

API Note: Уведомляет о предполагаемых значениях.

boolean toBoolean(final @Enumed({0, 1}) int value) {
    return value == 0 ? false : true;
}

Enumed::value()

Возвращает предполагаемые значения.

Returns: Предполагаемые значения.

Implementation Requirements: Предполагаемые значения не должны повторяться.

boolean toBoolean(final @Enumed({0, 1}) int value) {
    return value == 0 ? false : true;
}

Experimental::value()

Возвращает идентификатор выпуска, в котором ожидается, что состояние чего-то будет изменено.

Returns: Идентификатор выпуска, в котором ожидается, что состояние чего-то будет изменено.

@Experimental("3.7.4-RC1")
void work() {
    System.gc();
}

Magical

Магическое значение.

API Note: Уведомляет о магическом значении, содержащимся в поле или локальной переменной.

void operate(final @Magical int code) {
    final @Magical var limit = 256;
    if (code > limit) System.gc();
}

Range

Диапазон числовых значений.

API Note: Позволяет задать диапазон числовых значений.

void operate(final @Range(from = 0, to = 256) int code) {
    if (code == 0) System.gc();
}

Изменено:

Аннотации:

Contract

Изменена документация.

Contract::value()

Изменена документация — я добавил описание синтаксиса.
Изменена сигнатура.

Contract::pure()

Изменена документация.
Изменена сигнатура.

Experimental

Изменена документация.

Nls

Изменена документация.
Изменено тело.

NotNls

Изменена документация.
Изменено тело.

NotNull

Изменена документация.
Изменено тело.

Null

Изменена документация.
Изменено тело.

Nullable

Изменена документация.
Изменено тело.

Obsolete

Изменена документация.

Obsolete::value()

Изменена документация.
Изменена сигнатура.

Removal

Изменена документация.

Removal::value()

Изменена документация.
Изменена сигнатура.

Другое:

com.bloogefest.annotation.analysis

Изменена документация.

com.bloogefest.annotation

Изменена документация.

Assets 5

01 Jun 09:59

Bloogefest

2.1.0-RC1

134b2db

2.1.0-RC1 Pre-release

Pre-release

Этот предварительный выпуск совместим с предыдущим стабильным.

Подробнее о релизе: 2.0.0...2.1.0-RC1

Maven

<repository>
  <id>ossrh-rc</id>
  <name>OSSRH RC</name>
  <url>https://s01.oss.sonatype.org/content/repositories/releases/</url>
</repository>

<dependency>
  <groupId>com.bloogefest</groupId>
  <artifactId>annotation</artifactId>
  <version>2.1.0-RC1</version>
</dependency>

Gradle

repositories {
    maven {
        name = "OSSRH RC"
        url = uri("https://s01.oss.sonatype.org/content/repositories/releases/")
    }
}

dependencies {
    implementation("com.bloogefest:annotation:2.1.0-RC1")
}

Введено:

Аннотации:

Enumed

Перечисление значений.

API Note: Уведомляет о предполагаемых значениях.

boolean toBoolean(final @Enumed({0, 1}) int value) {
    return value == 0 ? false : true;
}

Enumed::value()

Возвращает предполагаемые значения.

Returns: Предполагаемые значения.

Implementation Requirements: Предполагаемые значения не должны повторяться.

boolean toBoolean(final @Enumed({0, 1}) int value) {
    return value == 0 ? false : true;
}

Experimental::value()

Возвращает идентификатор выпуска, в котором ожидается, что состояние чего-то будет изменено.

Returns: Идентификатор выпуска, в котором ожидается, что состояние чего-то будет изменено.

@Experimental("3.7.4-RC1")
void work() {
    System.gc();
}

Magical

Магическое значение.

API Note: Уведомляет о магическом значении, содержащимся в поле или локальной переменной.

void operate(final @Magical int code) {
    final @Magical var limit = 256;
    if (code > limit) System.gc();
}

Range

Диапазон числовых значений.

API Note: Позволяет задать диапазон числовых значений.

void operate(final @Range(from = 0, to = 256) int code) {
    if (code == 0) System.gc();
}

Изменено:

Аннотации:

Contract

Изменена документация.

Contract::value()

Изменена документация — я добавил описание синтаксиса.
Изменена сигнатура.

Contract::pure()

Изменена документация.
Изменена сигнатура.

Experimental

Изменена документация.

Nls

Изменена документация.
Изменено тело.

NotNls

Изменена документация.
Изменено тело.

NotNull

Изменена документация.
Изменено тело.

Null

Изменена документация.
Изменено тело.

Nullable

Изменена документация.
Изменено тело.

Obsolete

Изменена документация.

Obsolete::value()

Изменена документация.
Изменена сигнатура.

Removal

Изменена документация.

Removal::value()

Изменена документация.
Изменена сигнатура.

Другое:

com.bloogefest.annotation.analysis

Изменена документация.

com.bloogefest.annotation

Изменена документация.

Assets 5

22 Apr 17:15

Bloogefest

2.0.0

db2545b

2.0.0

Этот стабильный выпуск несовместим с предыдущим.

Произведена демодуляризация проекта.

Подробнее о релизе: 1.0.1...2.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>2.0.0</version>
</dependency>

Gradle

repositories {
    mavenCentral()
}

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

Введено:

Аннотации:

Removal

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

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

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

Removal::value()

Содержит идентификатор выпуска, в котором это будет гарантированно удалено.

Returns: Идентификатор выпуска, в котором это будет гарантированно удалено.

@Removal("3.7.4")
final boolean dev = true;
System.out.println(dev); // Не рекомендуется к использованию

Удалено:

Другое:

com.bloogefest.annotation

Assets 5

22 Apr 17:06

Bloogefest

2.0.0-RC1

1b2cb0a

2.0.0-RC1 Pre-release

Pre-release

Этот предварительный выпуск несовместим с предыдущим стабильным.

Произведена демодуляризация проекта.

Подробнее о релизе: 1.0.1...2.0.0-RC1

Maven

<repository>
  <id>ossrh-rc</id>
  <name>OSSRH RC</name>
  <url>https://s01.oss.sonatype.org/content/repositories/releases/</url>
</repository>

<dependency>
  <groupId>com.bloogefest</groupId>
  <artifactId>annotation</artifactId>
  <version>2.0.0-RC1</version>
</dependency>

Gradle

repositories {
    maven {
        name = "OSSRH RC"
        url = uri("https://s01.oss.sonatype.org/content/repositories/releases/")
    }
}

dependencies {
    implementation("com.bloogefest:annotation:2.0.0-RC1")
}

Введено:

Аннотации:

Removal

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

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

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

Removal::value()

Содержит идентификатор выпуска, в котором это будет гарантированно удалено.

Returns: Идентификатор выпуска, в котором это будет гарантированно удалено.

@Removal("3.7.4")
final boolean dev = true;
System.out.println(dev); // Не рекомендуется к использованию

Удалено:

Другое:

com.bloogefest.annotation

Assets 5

12 Apr 15:43

Bloogefest

1.0.1

99f0854

1.0.1

Этот стабильный релиз совместим с предыдущим.

Подробнее о релизе: 1.0.0...1.0.1

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.1</version>
</dependency>

Gradle

repositories {
    mavenCentral()
}

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

Изменено:

Другое:

com.bloogefest.annotation

Открыт доступ к пакету com.bloogefest.annotation.analysis.

Assets 5

12 Apr 15:37

Bloogefest

1.0.1-RC1

d2f3c7e

1.0.1-RC1 Pre-release

Pre-release

Этот предварительный релиз совместим с предыдущим стабильным.

Подробнее о релизе: 1.0.0...1.0.1-RC1

Maven

<repository>
  <id>ossrh-rc</id>
  <name>OSSRH RC</name>
  <url>https://s01.oss.sonatype.org/content/repositories/releases/</url>
</repository>

<dependency>
  <groupId>com.bloogefest</groupId>
  <artifactId>annotation</artifactId>
  <version>1.0.1-RC1</version>
</dependency>

Gradle

repositories {
    maven {
        name = "OSSRH RC"
        url = uri("https://s01.oss.sonatype.org/content/repositories/releases/")
    }
}

dependencies {
    implementation("com.bloogefest:annotation:1.0.1-RC1")
}

Изменено:

Другое:

com.bloogefest.annotation

Открыт доступ к пакету com.bloogefest.annotation.analysis.

Assets 5

11 Apr 09:45

Bloogefest

1.0.0

07826df

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());

Assets 5

Releases: Bloogefest/BF.Annotation

3.0.0

Maven

Gradle

Введено:

Аннотации:

3.0.0-RC2

Maven

Gradle

Изменено:

Аннотации:

3.0.0-RC1

Maven

Gradle

Введено:

Аннотации:

2.1.0

Maven

Gradle

Введено:

Аннотации:

Изменено:

Аннотации:

Другое:

2.1.0-RC1

Maven

Gradle

Введено:

Аннотации:

Изменено:

Аннотации:

Другое:

2.0.0

Maven

Gradle

Введено:

Аннотации:

Удалено:

Другое:

2.0.0-RC1

Maven

Gradle

Введено:

Аннотации:

Удалено:

Другое:

1.0.1

Maven

Gradle

Изменено:

Другое:

1.0.1-RC1

Maven

Gradle

Изменено:

Другое:

1.0.0

Maven

Gradle

Введено:

Аннотации: