Added
Link Here
|
1 |
/* |
2 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
3 |
* |
4 |
* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved. |
5 |
* |
6 |
* Oracle and Java are registered trademarks of Oracle and/or its affiliates. |
7 |
* Other names may be trademarks of their respective owners. |
8 |
* |
9 |
* The contents of this file are subject to the terms of either the GNU |
10 |
* General Public License Version 2 only ("GPL") or the Common |
11 |
* Development and Distribution License("CDDL") (collectively, the |
12 |
* "License"). You may not use this file except in compliance with the |
13 |
* License. You can obtain a copy of the License at |
14 |
* http://www.netbeans.org/cddl-gplv2.html |
15 |
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the |
16 |
* specific language governing permissions and limitations under the |
17 |
* License. When distributing the software, include this License Header |
18 |
* Notice in each file and include the License file at |
19 |
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this |
20 |
* particular file as subject to the "Classpath" exception as provided |
21 |
* by Oracle in the GPL Version 2 section of the License file that |
22 |
* accompanied this code. If applicable, add the following below the |
23 |
* License Header, with the fields enclosed by brackets [] replaced by |
24 |
* your own identifying information: |
25 |
* "Portions Copyrighted [year] [name of copyright owner]" |
26 |
* |
27 |
* Contributor(s): |
28 |
* |
29 |
* The Original Software is NetBeans. The Initial Developer of the Original |
30 |
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun |
31 |
* Microsystems, Inc. All Rights Reserved. |
32 |
* |
33 |
* If you wish your version of this file to be governed by only the CDDL |
34 |
* or only the GPL Version 2, indicate your decision by adding |
35 |
* "[Contributor] elects to include this software in this distribution |
36 |
* under the [CDDL or GPL Version 2] license." If you do not indicate a |
37 |
* single choice of license, a recipient has the option to distribute |
38 |
* your version of this file under either the CDDL, the GPL Version 2 or |
39 |
* to extend the choice of license to its licensees as provided above. |
40 |
* However, if you add GPL Version 2 code and therefore, elected the GPL |
41 |
* Version 2 license, then the option applies only if the new code is |
42 |
* made subject to such option by the copyright holder. |
43 |
*/ |
44 |
|
45 |
package org.netbeans.modules.web.clientproject.indirect; |
46 |
|
47 |
import java.beans.PropertyChangeListener; |
48 |
import java.util.Map; |
49 |
import org.netbeans.api.annotations.common.CheckForNull; |
50 |
import org.netbeans.api.annotations.common.NonNull; |
51 |
|
52 |
/** |
53 |
* A way of mapping property names to values. |
54 |
* <p> |
55 |
* This interface defines no independent thread safety, but in typical usage |
56 |
* it will be used with the project manager mutex. Changes should be fired |
57 |
* synchronously. |
58 |
* @author Jesse Glick |
59 |
* @see PropertyUtils#sequentialPropertyEvaluator |
60 |
* @see AntProjectHelper#getStandardPropertyEvaluator |
61 |
*/ |
62 |
public interface PropertyEvaluator { |
63 |
|
64 |
/** |
65 |
* Evaluate a single property. |
66 |
* @param prop the name of a property |
67 |
* @return its value, or null if it is not defined or its value could not be |
68 |
* retrieved for some reason (e.g. a circular definition) |
69 |
*/ |
70 |
@CheckForNull String getProperty(@NonNull String prop); |
71 |
|
72 |
/** |
73 |
* Evaluate a block of text possibly containing property references. |
74 |
* The syntax is the same as for Ant: <samp>${foo}</samp> means the value |
75 |
* of the property <samp>foo</samp>; <samp>$$</samp> is an escape for |
76 |
* <samp>$</samp>; references to undefined properties are left unsubstituted. |
77 |
* @param text some text possibly containing one or more property references |
78 |
* @return its value, or null if some problem (such a circular definition) made |
79 |
* it impossible to retrieve the values of some properties |
80 |
*/ |
81 |
@CheckForNull String evaluate(@NonNull String text); |
82 |
|
83 |
/** |
84 |
* Get a set of all current property definitions at once. |
85 |
* This may be more efficient than evaluating individual properties, |
86 |
* depending on the implementation. |
87 |
* @return an immutable map from property names to values, or null if the |
88 |
* mapping could not be computed (e.g. due to a circular definition) |
89 |
*/ |
90 |
@CheckForNull Map<String,String> getProperties(); |
91 |
|
92 |
/** |
93 |
* Add a listener to changes in particular property values. |
94 |
* As generally true with property change listeners, the old and new |
95 |
* values may both be null in case the true values are not known or not |
96 |
* easily computed; and the property name might be null to signal that any |
97 |
* property might have changed. |
98 |
* @param listener a listener to add |
99 |
*/ |
100 |
void addPropertyChangeListener(PropertyChangeListener listener); |
101 |
|
102 |
/** |
103 |
* Remove a listener to changes in particular property values. |
104 |
* @param listener a listener to remove |
105 |
*/ |
106 |
void removePropertyChangeListener(PropertyChangeListener listener); |
107 |
|
108 |
} |