From 30abd8d3c2e8fd953cfb68d0817e75c06665c15e Mon Sep 17 00:00:00 2001 From: Andrew Branson Date: Thu, 2 Oct 2014 17:17:17 +0200 Subject: Collection javadoc and cleanup --- .../c2kernel/collection/CollectionDescription.java | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) (limited to 'src/main/java/com/c2kernel/collection/CollectionDescription.java') 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 { + + /** + * 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 newInstance() throws ObjectNotFoundException; } -- cgit v1.2.3