com.cedarsoft.registry.Registry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of registry Show documentation
There is a newer version: 7.2.0
/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.registry;

import com.cedarsoft.commons.Converter;
import com.cedarsoft.exceptions.NotFoundException;
import com.cedarsoft.exceptions.StillContainedException;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;

import java.util.Comparator;
import java.util.List;

/**
 * Registry interface.
 *
 * @author Johannes Schneider ([email protected])
 * @param  the type this registry stores
 */
@ThreadSafe
public interface Registry {
  /**
   * Returns the stored objects
   *
   * @return the stored objects
   */
  @Nonnull
  List getStoredObjects();

  /**
   * Returns the first object that matches the matcher
   *
   * @param matcher the matcher
   * @return the first object that matches or null
   */
  @Nullable
  T findStoredObject( @Nonnull Matcher matcher );

  /**
   * Finds the stored objects
   *
   * @param matcher         the matcher
   * @param notFoundMessage the exception message that is thrown if no object could be found
   * @return the (first) object that matches the matcher
   */
  @Nonnull
  T findStoredObject( @Nonnull Matcher matcher, @Nonnull String notFoundMessage ) throws NotFoundException;

  /**
   * Finds the stored objects
   *
   * @param matcher the matcher
   * @return the found objects that match the matcher
   */
  @Nonnull
  List findStoredObjects( @Nonnull Matcher matcher );

  /**
   * Returns the stored objects
   *
   * @param matcher   the matcher
   * @param converter the converter
   * @param        the type of the target of the conversion
   * @return the matched and converted objects
   */
  @Nonnull
   List findStoredObjects( @Nonnull Matcher matcher, @Nonnull Converter converter );

  /**
   * Stores the object
   *
   * @param object the object that is stored
   */
  void store( @Nonnull T object ) throws StillContainedException;

  /**
   * Notify that the object has been updated
   *
   * @param object the object that has been updated
   */
  void updated( @Nonnull T object ) throws NotFoundException;

  /**
   * Returns the (optional) comparator
   *
   * @return the used comparator or null if no comparator is available
   */
  @Nullable
  Comparator getComparator();

  /**
   * Whether this registry only contains unique elements
   *
   * @return whether this registry only contains unique elements
   */
  boolean containsOnlyUniqueElements();

  /**
   * Adds a listener
   *
   * @param listener the listener
   */
  void addListener( @Nonnull Listener listener );

  /**
   * Removes the listeners
   *
   * @param listener the listener that is removed
   */
  void removeListener( @Nonnull Listener listener );

  /**
   * Removes the object
   *
   * @param object the object
   */
  void remove( @Nonnull T object ) throws NotFoundException;

  void remove( @Nonnull T object, @Nonnull String removeMessage ) throws NotFoundException;

  /**
   * The listener that is notified about changes of the registry
   *
   * @param  the type
   */
  interface Listener {
    /**
     * Is called if a new object has been stored
     *
     * @param object the object
     */
    void objectStored( @Nonnull T object );

    /**
     * The object that has been removed
     *
     * @param object the object that has been removed
     */
    void objectRemoved( @Nonnull T object );

    /**
     * The object that has been updated
     *
     * @param object the object that has been updated
     */
    void objectUpdated( @Nonnull T object );
  }

  /**
   * A simple matcher
   *
   * @param  the type of the matcher
   */
  interface Matcher {
    /**
     * Whether the object matches
     *
     * @param object the object
     * @return true if the object matches, false otherwise
     */
    boolean matches( @Nonnull T object );
  }
}