/*
 * Copyright 2019, TeamDev. All rights reserved.
 *
 * Redistribution and use in source and/or binary forms, with or without
 * modification, must retain the above copyright notice and the following
 * disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package io.spine.base;

import com.google.errorprone.annotations.Immutable;
import com.google.protobuf.Message;

import static io.spine.util.Preconditions2.checkNotEmptyOrBlank;

/**
 * A common interface for the {@code string}-based unique identifiers.
 *
 * <p>The messages of suitable format are spotted by the Spine Model Compiler and marked with this
 * interface automatically.
 *
 * <p>By convention, a {@code string}-based identifier should have exactly one {@code string} field
 * named 'uuid':
 * <pre>
 *     {@code
 *
 *         message ProjectId {
 *             // UUID-based generated value.
 *             string uuid = 1;
 *         }
 *     }
 * </pre>
 *
 * @param <I>
 *         the type of the message
 */
@SuppressWarnings({"unchecked" /* Class cast correctness guaranteed by the interface contract. */,
        "InterfaceNeverImplemented" /* Used by the Protobuf Compiler plugin. */})
@Immutable
public interface UuidValue<I extends Message> extends SerializableMessage {

    /**
     * Obtains a {@code MessageClassifier} for types which define a single
     * string field named {@code uuid}.
     */
    static MessageClassifier classifier() {
        return new UuidValueClassifier();
    }

    /**
     * Generates a new identifier instance using a generated UUID value.
     */
    default I generate() {
        Class<I> thisClass = (Class<I>) this.getClass();
        UuidFactory<I> uuidFactory = UuidFactory.forClass(thisClass);
        return uuidFactory.newUuid();
    }

    /**
     * Creates a new identifier instance from the passed value.
     *
     * @throws IllegalArgumentException
     *         if the passed value is not a valid UUID string
     */
    default I of(String value) {
        checkNotEmptyOrBlank(value);
        Class<I> thisClass = (Class<I>) this.getClass();
        UuidFactory<I> uuidFactory = UuidFactory.forClass(thisClass);
        return uuidFactory.newUuidOf(value);
    }
}

@@ -1123,74 +1123,8 @@
 e;%0A%0A
-import static io.spine.util.Preconditions2.checkNotEmptyOrBlank;%0A%0A
 /**%0A
@@ -1689,97 +1689,8 @@
 ngs(
-%7B%22unchecked%22 /* Class cast correctness guaranteed by the interface contract. */,%0A        
 %22Int
@@ -1712,17 +1712,17 @@
 emented%22
- 
+)
 /* Used 
@@ -1760,10 +1760,8 @@
 . */
-%7D)
 %0A@Im
@@ -2016,24 +2016,24 @@
 ssifier() %7B%0A
+
         retu
@@ -2071,733 +2071,7 @@
    %7D
-%0A%0A    /**%0A     * Generates a new identifier instance using a generated UUID value.%0A     */%0A    default I generate() %7B%0A        Class%3CI%3E thisClass = (Class%3CI%3E) this.getClass();%0A        UuidFactory%3CI%3E uuidFactory = UuidFactory.forClass(thisClass);%0A        return uuidFactory.newUuid();%0A    %7D%0A%0A    /**%0A     * Creates a new identifier instance from the passed value.%0A     *%0A     * @throws IllegalArgumentException%0A     *         if the passed value is not a valid UUID string%0A     */%0A    default I of(String value) %7B%0A        checkNotEmptyOrBlank(value);%0A        Class%3CI%3E thisClass = (Class%3CI%3E) this.getClass();%0A        UuidFactory%3CI%3E uuidFactory = UuidFactory.forClass(thisClass);%0A        return uuidFactory.newUuidOf(value);%0A    %7D
 %0A%7D%0A

Remove obsolete methods