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: package org.netbeans.spi.editor.errorstripe;
043:
044: import java.beans.PropertyChangeListener;
045: import java.beans.PropertyChangeSupport;
046: import org.netbeans.modules.editor.errorstripe.apimodule.SPIAccessor;
047:
048: /**UpToDateStatus provider.
049: *
050: * TODO: better javadoc.
051: *
052: * @author Jan Lahoda
053: */
054: public abstract class UpToDateStatusProvider {
055:
056: static {
057: SPIAccessor.DEFAULT = new SPIAccessorImpl();
058: }
059:
060: /**Name of property which should be fired when the up-to-date status changes.
061: */
062: public static final String PROP_UP_TO_DATE = "upToDate"; // NOI18N
063:
064: private PropertyChangeSupport pcs;
065:
066: /** Creates a new instance of MarkProvider */
067: public UpToDateStatusProvider() {
068: pcs = new PropertyChangeSupport(this );
069: }
070:
071: /**Report whether the current annotations attached to the documents are up-to-date
072: * (the meaning of up-to-date is left on the provider).
073: *
074: * If a provider does not provide this information, it should
075: * always return {@link UpToDateStatus#UP_TO_DATE_OK} value.
076: *
077: * @return a value of the {@link UpToDateStatus} enum.
078: *
079: * @see UpToDateStatus#UP_TO_DATE_OK
080: * @see UpToDateStatus#UP_TO_DATE_PROCESSING
081: * @see UpToDateStatus#UP_TO_DATE_DIRTY
082: *
083: */
084: public abstract UpToDateStatus getUpToDate();
085:
086: /**Register a {@link PropertyChangeListener}.
087: *
088: * @param l listener to register
089: */
090: /*package private*/final void addPropertyChangeListener(
091: PropertyChangeListener l) {
092: pcs.addPropertyChangeListener(l);
093: }
094:
095: /**Unregister a {@link PropertyChangeListener}.
096: *
097: * @param l listener to register
098: */
099: /*package private*/final void removePropertyChangeListener(
100: PropertyChangeListener l) {
101: pcs.removePropertyChangeListener(l);
102: }
103:
104: /**Fire property change event to all registered listener. Subclasses should call
105: * this method when they need to fire the {@link java.beans.PropertyChangeEvent}
106: * because property {@link #PROP_UP_TO_DATE} have changed.
107: *
108: * @param name name of the property ({@link #PROP_UP_TO_DATE})
109: * @param old previous value of the property or null if unknown
110: * @param nue current value of the property or null if unknown
111: */
112: protected final void firePropertyChange(String name, Object old,
113: Object nue) {
114: pcs.firePropertyChange(name, old, nue);
115: }
116:
117: }
|