KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > slide > common > RequestedProperties


1 /*
2  * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/common/RequestedProperties.java,v 1.6 2004/07/28 09:38:17 ib Exp $
3  * $Revision: 1.6 $
4  * $Date: 2004/07/28 09:38:17 $
5  *
6  * ====================================================================
7  *
8  * Copyright 1999-2002 The Apache Software Foundation
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License");
11  * you may not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS,
18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  *
22  */

23
24 package org.apache.slide.common;
25
26 import org.apache.slide.content.NodeProperty;
27 import java.util.Iterator JavaDoc;
28
29
30 /**
31  * With this you may find out, if a specific property is wanted by the request.
32  *
33  * @version $Revision: 1.6 $
34  */

35 public interface RequestedProperties {
36     
37     /**
38      * Checks, if the property identified by name and namespace, is requested
39      *
40      * @param name name of the property to be checked
41      * @param namespace namespace of the property to be checked
42      *
43      * @return true, if property is requested
44      */

45     boolean contains (String JavaDoc name, String JavaDoc namespace);
46     
47     /**
48      * Checks, if the NodeProperty is a RequestedProperty
49      *
50      * @param property NodeProperty to be checked
51      *
52      * @return true, if property is requested
53      *
54      */

55     boolean contains (NodeProperty property);
56     
57     /**
58      * Method isAllProp
59      *
60      * @return true, if all properties are requested
61      *
62      */

63     boolean isAllProp ();
64
65     /**
66      * Set whether this is an allProp request or not.
67      */

68     void setIsAllProp(boolean isAllProp);
69     
70     /**
71      * Method getRequestedProperties
72      *
73      * @return an Iterator to retrieve all RequestedProperty items
74      * @throws IllegalStateException when isAllProp == true
75      */

76     Iterator JavaDoc getRequestedProperties ();
77 }
78
79
Popular Tags