org.cp.elements.lang.Verifiable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cp-elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development.

There is a newer version: 2.0.0-M1

Show newest version

/*
 * Copyright 2016 Author or Authors.
 *
 * Licensed 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 org.cp.elements.lang;

/**
 * The {@link Verifiable} interface defines a contract for implementing {@link Object objects} capable of
 * validating that any soft constraints, invariants and business rules of this implementing {@link Object object}
 * are upheld.
 *
 * @author John Blum
 * @param  {@link Class type} of the {@link Object} implementing this interface.
 * @see org.cp.elements.lang.Verifier
 * @since 1.0.0
 */
@SuppressWarnings("unused")
public interface Verifiable {

  /**
   * Determines whether this {@link Verifiable} object is valid.
   *
   * @return a boolean value indicating whether this {@link Verifiable} object is valid.
   * @see #validate()
   */
  default boolean isValid() {

    try {
      return validate() != null;
    }
    catch (RuntimeException ignore) {
      return false;
    }
  }

  /**
   * Validates the constraints and invariants of this implementing {@link Object}.
   *
   * @return this implementing {@link Verifiable} {@link Object}.
   */
  T validate();

  /**
   * Verifies this {@link Verifiable} with the given {@link Verifier}.
   *
   * @param verifier {@link Verifier} used to verify, or validate this {@link Verifiable} object.
   * @return this {@link Verifiable} object.
   * @see org.cp.elements.lang.Verifier
   */
  @SuppressWarnings("unchecked")
  default T verify(Verifier verifier) {

    verifier.verify(this);

    return (T) this;
  }
}