arez.component.Verifiable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arez-core Show documentation

Arez Core

There is a newer version: 0.213

package arez.component;

import arez.Arez;
import javax.annotation.Nonnull;

/**
 * Interface implemented by components that can verify their internal state.
 */
public interface Verifiable
{
  /**
   * verify the state of the component and raise an exception if any state fails to verify.
   *
   * @throws Exception if entity invalid.
   */
  void verify()
    throws Exception;

  /**
   * Verify they supplied object if it is verifiable.
   *
   * @param object the object to verify.
   * @throws Exception if entity invalid.
   */
  static void verify( @Nonnull final Object object )
    throws Exception
  {
    if ( Arez.isVerifyEnabled() )
    {
      if ( object instanceof Verifiable )
      {
        ( (Verifiable) object ).verify();
      }
    }
  }
}