xref: /illumos-gate/usr/src/cmd/pools/poold/com/sun/solaris/service/pools/PropertyWalk.java (revision 1a065e93eee983124652c3eb0cfdcb4776cd89ab)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  *
26  */
27 
28 package com.sun.solaris.service.pools;
29 
30 import java.util.List;
31 import java.util.ArrayList;
32 
33 /**
34  * The <code>PropertyWalk</code> interface specifies the contract
35  * between a pools configuration element and clients which are
36  * interested in enumerating the properties of the element.
37  */
38 
39 public interface PropertyWalk {
40 	/**
41 	 * Walk all properties of the invoking object, calling the
42 	 *
43 	 * @param elem The element to whom the property belongs.
44 	 * @param val The value representing the current element.
45 	 * @param user User supplied data, provided when the walk is invoked.
46 	 * @throws PoolsException If there is an error walking the property.
47 	 * @return 0 to continue the walk, anything else to terminate it.
48 	 */
49 	public int walk(Element elem, Value val, Object user)
50 	    throws PoolsException;
51 }
52