refactoring of the config interface towards more reuse in the implementation and...

[xmlrouter] / config / src / main / java / org / wamblee / xmlrouter / config / Config.java

diff --git a/config/src/main/java/org/wamblee/xmlrouter/config/Config.java b/config/src/main/java/org/wamblee/xmlrouter/config/Config.java
new file mode 100644 (file)
index 0000000..b90b34c
--- /dev/null
+++ b/config/src/main/java/org/wamblee/xmlrouter/config/Config.java
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2005-2011 the original 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.wamblee.xmlrouter.config;
+
+import java.util.Collection;
+
+import org.wamblee.xmlrouter.common.Id;
+
+/**
+ * Basic configuration interface for managing a set of configuration items of a
+ * given type with unique ids.
+ * 
+ * @author Erik Brakkee
+ * 
+ * @param <T>
+ *            Type for which ids are generated.
+ */
+public interface Config<T> {
+
+    /**
+     * Adds a item
+     * 
+     * @param aT
+     *            item
+     * @return Unique id.
+     */
+    Id<T> add(T aT);
+
+    /**
+     * Removes the item with a given id.
+     * 
+     * @param aId
+     *            Item id.
+     * @return true iff the item was removed.
+     */
+    boolean remove(Id<T> aId);
+
+    /**
+     * @return All available ids.
+     */
+    Collection<Id<T>> ids();
+
+    /**
+     * Gets the item for the given id.
+     * 
+     * @param aId
+     *            Item id.
+     * @return Item, or null if not found.
+     */
+    T get(Id<T> aId);
+
+}
\ No newline at end of file