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: package org.netbeans.modules.xml.sync;
042:
043: import org.openide.nodes.*;
044:
045: /**
046: * Same data may have multiple representations. A representation can
047: * be described using this interface.
048: *
049: * @author Petr Kuzel
050: * @version
051: */
052: public interface Representation {
053:
054: /**
055: * @return select button diplay name used during notifying concurent modification
056: * conflict.
057: */
058: public String getDisplayName();
059:
060: /**
061: * Is this representation modified since last update?
062: * Warning isModified() does not equals representationChanged().
063: */
064: public boolean isModified();
065:
066: /**
067: * Determine whether given representation is valid. E.g. tree
068: * represnattion is valid just if parsed successfully.
069: */
070: public boolean isValid();
071:
072: /**
073: * Update the representation without marking it as modified.
074: */
075: public void update(Object change);
076:
077: /**
078: * Return prefered update class or null if does not matter.
079: * //??? Could return <codE>Class[]</code> in future.
080: */
081: public Class getUpdateClass();
082:
083: /**
084: * Return modification passed as update parameter to all slave representations.
085: * @param type if null return arbitrary representation
086: * @return Change or null if change of given type can not be returned
087: */
088: public Object getChange(Class type);
089:
090: /**
091: * Does this representation wraps given model?
092: */
093: public boolean represents(Class type);
094:
095: /**
096: * Returnrepresentation level: 0 = file, 1 = byte buffer [text],
097: * 2 = structural model, 3 = semantics model ... A higher level
098: * representaion requires that lower level representation is
099: * loaded too.
100: *
101: * @return
102: */
103: public int level();
104: }
|