net.nemerosa.ontrack.model.structure.ID Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ontrack-model Show documentation

Ontrack module: ontrack-model

There is a newer version: 4.4.5

package net.nemerosa.ontrack.model.structure;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Data;
import net.nemerosa.ontrack.model.support.IDJsonDeserializer;
import net.nemerosa.ontrack.model.support.IDJsonSerializer;
import org.apache.commons.lang3.Validate;

import java.io.Serializable;
import java.util.Optional;
import java.util.function.Function;

@Data
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@JsonSerialize(using = IDJsonSerializer.class)
@JsonDeserialize(using = IDJsonDeserializer.class)
public final class ID implements Serializable {

    /**
     * Undefined ID.
     * 
     * Its integer value is 0 and a call to {@link #isSet()} returns false.
     */
    public static ID NONE = new ID(0);

    /**
     * Builds a defined ID. The given value must be an integer greater than 0.
     *
     * @param value The concrete ID value
     * @return A defined ID.
     * @throws java.lang.IllegalArgumentException If value is less or equal than 0.
     */
    public static ID of(int value) {
        Validate.isTrue(value > 0, "ID value must be greater than zero.");
        return new ID(value);
    }

    private final int value;

    @Override
    public String toString() {
        return String.valueOf(value);
    }

    public int get() {
        return value;
    }

    public boolean isSet() {
        return value > 0;
    }

    public static boolean isDefined(ID id) {
        return id != null && id.isSet();
    }

    public  Optional ifSet(Function fn) {
        if (isSet()) {
            return Optional.ofNullable(fn.apply(value));
        } else {
            return Optional.empty();
        }
    }
}