1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. 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 package org.apache.commons.flatfile;
18
19 /**
20 * EntityCollection whose children are indexed.
21 * @version $Revision: 758023 $ $Date: 2009-03-24 16:09:19 -0500 (Tue, 24 Mar 2009) $
22 */
23 public interface IndexedEntityCollection extends EntityCollection {
24 /**
25 * Get the size (# of child elements) of this IndexedEntityCollection.
26 * @return int
27 */
28 int size();
29
30 /**
31 * Get the child at the specified index.
32 * @param index int
33 * @return Entity
34 */
35 Entity getChild(int index);
36
37 /**
38 * Learn whether the size of this object can be set.
39 * @return boolean
40 */
41 boolean isSizable();
42
43 /**
44 * Set new size of this object.
45 * @param size to set
46 * @throws IllegalStateException if {@link #isSizable()} <code>== false</code>
47 */
48 void setSize(int size) throws IllegalStateException;
49 }