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-2007 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 com.sun.data.provider;
043:
044: /**
045: * <p>Behavioral interface that is implemented by {@link DataProvider} classes
046: * that offer commit/revert support. In such environments, methods that modify
047: * the data element values (such as <code>setValue()</code>) must cause the new
048: * values to be cached, and the underlying data elements are not actually
049: * updated until <code>commitChanges()</code> is called. An application may
050: * also call <code>revertChanges()</code> to throw away any cached updates. In
051: * spite of this caching, however, <code>valueChanged()</code> events must still
052: * be sent to registered {@link DataListener}s -- an instance of
053: * {@link TransactionalDataListener} will also be notified when the
054: * actual <code>commitChanges()</code> or <code>revertChanges()</code> occurs.
055: * </p>
056: *
057: * <p>During the time between when a modification method (such as
058: * <code>setValue()</code> is called, and a later call to
059: * <code>commitChanges()</code>, any calls to <code>getType()</code> or
060: * <code>getValue()</code> will reflect the modified value from the cache, not
061: * the original value from the underlying data structure.</p>
062: *
063: * @author Craig McClanahan
064: * @author Joe Nuxoll
065: */
066: public interface TransactionalDataProvider extends DataProvider {
067:
068: // ----------------------------------------------------- Flush/Clear Methods
069:
070: /**
071: * <p>Cause any cached changes to values of data elements supported by this
072: * {@link DataProvider} to be passed through to the underlying data
073: * structure.</p>
074: *
075: * @throws DataProviderException Implementations may wish to surface
076: * internal exceptions (nested in DataProviderException). Consult
077: * the documentation of the specific DataProvider implementation for
078: * details on what exceptions might be wrapped by a DPE.
079: */
080: public void commitChanges() throws DataProviderException;
081:
082: /**
083: * <p>Cause any cached changes to values of data elements supported by this
084: * {@link DataProvider} to be thrown away, so that the initial values are
085: * again visible.</p>
086: *
087: * @throws DataProviderException Implementations may wish to surface
088: * internal exceptions (nested in DataProviderException). Consult
089: * the documentation of the specific DataProvider implementation for
090: * details on what exceptions might be wrapped by a DPE.
091: */
092: public void revertChanges() throws DataProviderException;
093:
094: // ---------------------------------------------- Event Registration Methods
095:
096: /**
097: * <p>Register a new {@link TransactionalDataListener} to this
098: * {@link TransactionalDataProvider} instance.</p>
099: *
100: * @param listener New {@link TransactionalDataListener} to register
101: */
102: public void addTransactionalDataListener(
103: TransactionalDataListener listener);
104:
105: /**
106: * <p>Deregister an existing {@link TransactionalDataListener} from
107: * {@link TransactionalDataProvider} instance.</p>
108: *
109: * @param listener Old {@link TransactionalDataListener} to remove
110: */
111: public void removeTransactionalDataListener(
112: TransactionalDataListener listener);
113:
114: /**
115: * @return An array of the {@link TransactionalDataListener}s
116: * currently registered on this {@link TransactionalDataProvider}.
117: * If there are no registered listeners, a zero-length array is
118: * returned.
119: */
120: public TransactionalDataListener[] getTransactionalDataListeners();
121: }
|