wamblee.org Git - xmlrouter/blob - config/src/main/java/org/wamblee/xmlrouter/config/Config.java

   1 /*
   2  * Copyright 2005-2011 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.xmlrouter.config;
  17
  18 import java.util.Collection;
  19
  20 import org.wamblee.xmlrouter.common.Id;
  21
  22 /**
  23  * Interface for managing a set of configuration items of a given type with
  24  * unique ids.
  25  *
  26  * @author Erik Brakkee
  27  *
  28  * @param <T>
  29  *            Type for which ids are generated.
  30  */
  31 public interface Config<T extends Identifiable> extends Identifiable<Config> {
  32
  33     /**
  34      * @return The type of contained object.
  35      */
  36     Class<T> getType();
  37
  38     /**
  39      * Adds an item. No item with the same id may exist.
  40      *
  41      * @param aT
  42      *            item
  43      * @throws ConfigException
  44      *             In case an object with the same id already exists.
  45      */
  46     void add(T aT);
  47
  48     /**
  49      * Removes the item with a given id.
  50      *
  51      * @param aId
  52      *            Item id.
  53      * @return true iff the item was removed.
  54      */
  55     boolean remove(Id<T> aId);
  56
  57     /**
  58      * @return All available items.
  59      */
  60     Collection<T> values();
  61 }