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.modules.xml.wsdl.model;
043:
044: import java.io.IOException;
045: import java.util.List;
046: import javax.xml.namespace.QName;
047: import org.netbeans.modules.xml.xam.Component;
048: import org.netbeans.modules.xml.xam.dom.DocumentModel;
049: import org.netbeans.modules.xml.xam.ComponentUpdater;
050:
051: /**
052: * Interface for wsdl extensibility elements
053: *
054: * @author rico
055: * @author Nam Nguyen
056: */
057: public interface ExtensibilityElement extends WSDLComponent {
058: public static final String CONTENT_FRAGMENT_PROPERTY = "content";
059:
060: /**
061: * Set/get attribute value.
062: */
063: public String getAttribute(String attribute);
064:
065: public void setAttribute(String attribute, String value);
066:
067: /**
068: * Set/get attribute defined in given namespace.
069: */
070: public String getAnyAttribute(QName attr);
071:
072: public void setAnyAttribute(QName attr, String value);
073:
074: /**
075: * Set/get content as XML fragment.
076: * The XML fragment will be parsed and the resulting nodes will
077: * replace the current children of this documentation element.
078: * @param text XML fragment text.
079: * @exception IOException if the fragment text is not well-form.
080: */
081: public String getContentFragment();
082:
083: public void setContentFragment(String fragment) throws IOException;
084:
085: /**
086: * Adds child extensibility elements of unknown type.
087: * @param anyElement any child component to add
088: * @param index absolute index position in children list.
089: */
090: public void addAnyElement(ExtensibilityElement anyElement, int index);
091:
092: /**
093: * Removes child extensibility element of unknown type.
094: */
095: public void removeAnyElement(ExtensibilityElement any);
096:
097: /**
098: * @returns list of children extensibility elements of unknown type.
099: */
100: public List<ExtensibilityElement> getAnyElements();
101:
102: /**
103: * Returns QName of the backing DOM element.
104: */
105: public QName getQName();
106:
107: /**
108: * Interface for an extensibility element that could provide update visitor
109: * to be used during sync from source.
110: */
111: interface UpdaterProvider extends ExtensibilityElement {
112: /**
113: * @return component updater to be used in merge operations when source sync happens.
114: */
115: <T extends ExtensibilityElement> ComponentUpdater<T> getComponentUpdater();
116: }
117:
118: /**
119: * Interface for an extensibility element that is a root of an embedded model.
120: */
121: interface EmbeddedModel extends ExtensibilityElement {
122: DocumentModel getEmbeddedModel();
123: }
124:
125: /**
126: * An extensibility element with ability to select parent to be added to.
127: */
128: interface ParentSelector extends ExtensibilityElement {
129: boolean canBeAddedTo(Component target);
130: }
131: }
|