View Javadoc

1   /*
2    * Copyright 2004-2005 the original author or authors.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
5    * use this file except in compliance with the License. You may obtain a copy of
6    * the License at
7    * 
8    * http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations under
14   * the License.
15   */
16  package net.sf.morph.wrap;
17  
18  
19  /**
20   * A wrapper for objects that can tell how many elements are contained within
21   * themselves.
22   * 
23   * @author Matt Sgarlata
24   * @since Jan 16, 2005
25   */
26  public interface Sizable extends Wrapper {
27  
28  	/**
29  	 * Returns the number of elements contained within this wrapper. If this
30  	 * wrapper is a bean, the number of properties is returned. If this wrapper
31  	 * is a container, the number of elements in the container is returned.
32  	 * 
33  	 * @return the number of elements contained in the given object
34  	 * @throws WrapperException
35  	 *             if the number of elements in the object could not be
36  	 *             determined
37  	 */
38  	public int getSize() throws WrapperException;
39  
40  }