diff options
| author | Andrew Branson <andrew.branson@cern.ch> | 2014-10-02 17:17:17 +0200 |
|---|---|---|
| committer | Andrew Branson <andrew.branson@cern.ch> | 2014-10-02 17:17:17 +0200 |
| commit | 30abd8d3c2e8fd953cfb68d0817e75c06665c15e (patch) | |
| tree | 1d61b0bf0231749a80aba7de620f9f6dcb168760 /src/main/java/com/c2kernel/collection/CollectionDescription.java | |
| parent | 032b65952188eeaded3157ac47e970b90eacdc96 (diff) | |
Collection javadoc and cleanup
Diffstat (limited to 'src/main/java/com/c2kernel/collection/CollectionDescription.java')
| -rw-r--r-- | src/main/java/com/c2kernel/collection/CollectionDescription.java | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/src/main/java/com/c2kernel/collection/CollectionDescription.java b/src/main/java/com/c2kernel/collection/CollectionDescription.java index f4d9f15..4b49ccd 100644 --- a/src/main/java/com/c2kernel/collection/CollectionDescription.java +++ b/src/main/java/com/c2kernel/collection/CollectionDescription.java @@ -22,15 +22,18 @@ package com.c2kernel.collection; import com.c2kernel.common.ObjectNotFoundException;
-/**************************************************************************
- *
- * $Revision: 1.1 $
- * $Date: 2003/03/11 11:09:07 $
- *
- * Copyright (C) 2003 CERN - European Organization for Nuclear Research
- * All rights reserved.
- **************************************************************************/
-
+/**
+ * A collection that can be instantiated. Collection descriptions link Item
+ * descriptions together, which constrains membership of their instance.
+ *
+ */
public interface CollectionDescription<E extends CollectionMember> {
+
+ /**
+ * Create a new instance of this collection.
+ * @return a new collection instance
+ * @throws ObjectNotFoundException When an essential piece of description
+ * data, such as a child Item PropertyDescription outcome, doesn't exist.
+ */
public Collection<E> newInstance() throws ObjectNotFoundException;
}
|