001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: /*
042: * ExPropertyEditorSupport.java
043: *
044: * Created on March 26, 2003, 4:38 PM
045: */
046:
047: package org.netbeans.beaninfo.editors;
048:
049: import java.beans.*;
050: import org.openide.explorer.propertysheet.*;
051:
052: /** Support class for ExPropertyEditor which provides means for validating
053: * hints from the PropertyEnv instance passed to attachEnv. Forces
054: * subclasses to be fail-fast in the case that illegal values are passed
055: * via the PropertyEnv (the alternative is cryptic error messages when
056: * the editor tries to use the hints).
057: * @author Tim Boudreau
058: * @version 1.0
059: */
060: public abstract class ExPropertyEditorSupport extends
061: PropertyEditorSupport implements ExPropertyEditor {
062:
063: /** Creates a new instance of ExPropertyEditorSupport */
064: protected ExPropertyEditorSupport() {
065: }
066:
067: /** Implementation of PropertyEditorSupport.attachEnv(). This method
068: * is final to ensure that the values from the env are validated.
069: * Subclasses should override attachEnvImpl to provide the actual
070: * attaching behavior. attachEnvImpl is called first, then
071: * validateEnv (to avoid fetching the values twice). */
072: public final void attachEnv(PropertyEnv env) {
073: attachEnvImpl(env);
074: validateEnv(env);
075: }
076:
077: /** Perform the actual attaching of the PropertyEnv. */
078: protected abstract void attachEnvImpl(PropertyEnv env);
079:
080: /** Validate values stored in the PropertyEnv. This method allows
081: * subclasses to be fail-fast if they are supplied illegal values
082: * as hints from the PropertyEnv. Subclasses should confirm that any
083: * hints used by their property editor are valid values. If they
084: * are not valid, an EnvException should be thrown with a clear
085: * description of the problem. */
086: protected abstract void validateEnv(PropertyEnv env);
087:
088: /** This class exists to enable unit tests to differentiate
089: * between code bugs in the editors and invalid values from
090: * the propertyEnv. */
091: public static class EnvException extends IllegalArgumentException {
092: public EnvException(String s) {
093: super (s);
094: }
095: }
096:
097: /** Utility method to convert an array of Objects into a comma
098: * delimited string. */
099: protected static final String arrToStr(Object[] s) {
100: if (s == null)
101: return "null"; //NOI18N
102: StringBuffer out = new StringBuffer(s.length * 10);
103: for (int i = 0; i < s.length; i++) {
104: if (s[i] != null) {
105: out.append(s[i]);
106: } else {
107: out.append("null");
108: }
109: if (i != s.length - 1) {
110: out.append(","); //NOI18N
111: }
112: }
113: return out.toString();
114: }
115: }
|