wamblee.org Git - xmlrouter/blob - router/impl/src/main/java/org/wamblee/xmlrouter/impl/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.impl;
  17
  18 import java.util.Collection;
  19
  20 import org.wamblee.xmlrouter.common.Id;
  21 import org.wamblee.xmlrouter.config.Identifiable;
  22
  23 /**
  24  * Interface for managing a set of configuration items of a given type with
  25  * unique ids.
  26  *
  27  * @author Erik Brakkee
  28  *
  29  * @param <T>
  30  *            Type for which ids are generated.
  31  */
  32 public interface Config<T extends Identifiable> {
  33
  34     /**
  35      * @return Prefix to use for ids of contained identifiable objects.
  36      */
  37     String getPrefix();
  38
  39     /**
  40      * @return The type of contained object.
  41      */
  42     Class<T> getType();
  43
  44     /**
  45      * Adds an item. No item with the same id may exist.
  46      *
  47      * @param aT
  48      *            item
  49      * @throws ConfigException
  50      *             In case an object with the same id already exists.
  51      */
  52     void add(T aT);
  53
  54     /**
  55      * Removes the item with a given id.
  56      *
  57      * @param aId
  58      *            Item id.
  59      * @return true iff the item was removed.
  60      */
  61     boolean remove(Id<T> aId);
  62
  63     /**
  64      * @return All available items.
  65      */
  66     Collection<T> values();
  67 }