io.hekate.core.ServiceProperty Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hekate-core Show documentation
Java library for cluster communications and computing.
There is a newer version: 4.1.3
/*
 * Copyright 2020 The Hekate Project
 *
 * The Hekate Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package io.hekate.core;

import io.hekate.core.internal.util.ArgAssert;
import io.hekate.util.format.ToString;
import java.io.Serializable;

/**
 * Property of {@link ServiceInfo}.
 *
 * @param  Property type.
 */
public final class ServiceProperty implements Serializable {
    /**
     * Service property type.
     *
     * @see ServiceProperty#type()
     */
    public enum Type {
        /** For {@link String} type. */
        STRING,

        /** For {@link Integer} type. */
        INTEGER,

        /** For {@link Long} type. */
        LONG,

        /** For {@link Boolean} type. */
        BOOLEAN
    }

    private static final long serialVersionUID = 1;

    private final Type type;

    private final String name;

    private final T value;

    private ServiceProperty(Type type, String name, T value) {
        ArgAssert.notNull(type, "Property type");
        ArgAssert.notNull(name, "Property name");
        ArgAssert.notNull(value, "Property value");

        this.type = type;
        this.name = name;
        this.value = value;
    }

    /**
     * Constructs a new property of {@link Type#STRING} type.
     *
     * @param name Property name.
     * @param value Property value.
     *
     * @return New property.
     */
    public static ServiceProperty forString(String name, String value) {
        return new ServiceProperty<>(Type.STRING, name, value);
    }

    /**
     * Constructs a new property of {@link Type#INTEGER} type.
     *
     * @param name Property name.
     * @param value Property value.
     *
     * @return New property.
     */
    public static ServiceProperty forInteger(String name, int value) {
        return new ServiceProperty<>(Type.INTEGER, name, value);
    }

    /**
     * Constructs a new property of {@link Type#LONG} type.
     *
     * @param name Property name.
     * @param value Property value.
     *
     * @return New property.
     */
    public static ServiceProperty forLong(String name, long value) {
        return new ServiceProperty<>(Type.LONG, name, value);
    }

    /**
     * Constructs a new property of {@link Type#BOOLEAN} type.
     *
     * @param name Property name.
     * @param value Property value.
     *
     * @return New property.
     */
    public static ServiceProperty forBoolean(String name, boolean value) {
        return new ServiceProperty<>(Type.BOOLEAN, name, value);
    }

    /**
     * Returns the property type.
     *
     * @return Property type.
     */
    public Type type() {
        return type;
    }

    /**
     * Returns the property name.
     *
     * @return Property name.
     */
    public String name() {
        return name;
    }

    /**
     * Returns the property value.
     *
     * @return Property value.
     */
    public T value() {
        return value;
    }

    @Override
    public String toString() {
        return ToString.format(this);
    }
}