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.api.xml.services;
042:
043: import java.util.Iterator;
044: import javax.xml.transform.URIResolver;
045:
046: import org.xml.sax.EntityResolver;
047: import org.openide.util.Lookup;
048:
049: // for JavaDoc
050: import org.openide.xml.EntityCatalog;
051:
052: /**
053: * Factory of user's catalog service instaces. A client cannot instantiate and
054: * use it directly. It can indirectly use instances are registeretered in a
055: * {@link Lookup} by providers.
056: * <p>
057: * It is user's level equivalent of system's entity resolution support
058: * {@link EntityCatalog} in OpenIDE API. Do not mix these,
059: * always use <code>UserCatalog</code> while working with user's files.
060: * User may, depending on provider implementation, use system catalog as
061: * user's one if needed.
062: *
063: * @author Libor Kramolis
064: * @author Petr Kuzel
065: * @since 0.5
066: */
067: public abstract class UserCatalog {
068:
069: // abstract to avoid instantionalization by API clients
070:
071: /**
072: * Utility method looking up for an instance in default Lookup.
073: * @return UserCatalog registered in default Lookup or <code>null</code>.
074: */
075: public static UserCatalog getDefault() {
076: return (UserCatalog) Lookup.getDefault().lookup(
077: UserCatalog.class);
078: }
079:
080: /**
081: * User's JAXP/TrAX <code>URIResolver</code>.
082: * @return URIResolver or <code>null</code> if not supported.
083: */
084: public URIResolver getURIResolver() {
085: return null;
086: }
087:
088: /**
089: * User's SAX <code>EntityResolver</code>.
090: * @return EntityResolver or <code>null</code> if not supported.
091: */
092: public EntityResolver getEntityResolver() {
093: return null;
094: }
095:
096: /**
097: * Read-only "sampled" iterator over all registered entity public IDs.
098: * @return all known public IDs or <code>null</code> if not supported.
099: */
100: // Svata suggested here a live collection, but he accepts this solution if it
101: // is only for informational purposes. It is.
102: public Iterator getPublicIDs() {
103: return null;
104: }
105: }
|