KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > poi > poifs > property > Parent


1
2 /* ====================================================================
3    Copyright 2002-2004 Apache Software Foundation
4
5    Licensed under the Apache License, Version 2.0 (the "License");
6    you may not use this file except in compliance with the License.
7    You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16 ==================================================================== */
17         
18
19 package org.apache.poi.poifs.property;
20
21 import java.util.Iterator JavaDoc;
22
23 import java.io.IOException JavaDoc;
24
25 /**
26  * Behavior for parent (directory) properties
27  *
28  * @author Marc Johnson27591@hotmail.com
29  */
30
31 public interface Parent
32     extends Child
33 {
34
35     /**
36      * Get an iterator over the children of this Parent; all elements
37      * are instances of Property.
38      *
39      * @return Iterator of children; may refer to an empty collection
40      */
41
42     public Iterator JavaDoc getChildren();
43
44     /**
45      * Add a new child to the collection of children
46      *
47      * @param property the new child to be added; must not be null
48      *
49      * @exception IOException if the Parent already has a child with
50      * the same name
51      */
52
53     public void addChild(final Property property)
54         throws IOException JavaDoc;
55
56     /**
57      * Set the previous Child
58      *
59      * @param child the new 'previous' child; may be null, which has
60      * the effect of saying there is no 'previous' child
61      */
62
63     public void setPreviousChild(final Child child);
64
65     /**
66      * Set the next Child
67      *
68      * @param child the new 'next' child; may be null, which has the
69      * effect of saying there is no 'next' child
70      */
71
72     public void setNextChild(final Child child);
73
74     /** *** end methods from interface Child *** */
75
76 } // end public interface Parent
77
78
Popular Tags