com.sun.org.apache.xml.internal.serialize.SerializerFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.bundles.jaxp-ri
Show all versions of org.apache.servicemix.bundles.jaxp-ri
This OSGi bundle wraps ${pkgArtifactId} ${pkgVersion} jar file.
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.sun.org.apache.xml.internal.serialize;
import java.io.OutputStream;
import java.io.Writer;
import java.io.UnsupportedEncodingException;
import java.util.Hashtable;
import java.util.StringTokenizer;
/**
*
*
* @version $Revision: 1.6 $ $Date: 2010-11-01 04:40:36 $
* @author Scott Boag
* @author Assaf Arkin
*/
public abstract class SerializerFactory
{
public static final String FactoriesProperty = "com.sun.org.apache.xml.internal.serialize.factories";
private static Hashtable _factories = new Hashtable();
static
{
SerializerFactory factory;
String list;
StringTokenizer token;
String className;
// The default factories are always registered first,
// any factory specified in the properties file and supporting
// the same method will override the default factory.
factory = new SerializerFactoryImpl( Method.XML );
registerSerializerFactory( factory );
factory = new SerializerFactoryImpl( Method.HTML );
registerSerializerFactory( factory );
factory = new SerializerFactoryImpl( Method.XHTML );
registerSerializerFactory( factory );
factory = new SerializerFactoryImpl( Method.TEXT );
registerSerializerFactory( factory );
list = System.getProperty( FactoriesProperty );
if ( list != null ) {
token = new StringTokenizer( list, " ;,:" );
while ( token.hasMoreTokens() ) {
className = token.nextToken();
try {
factory = (SerializerFactory) ObjectFactory.newInstance( className,
SerializerFactory.class.getClassLoader(), true);
if ( _factories.containsKey( factory.getSupportedMethod() ) )
_factories.put( factory.getSupportedMethod(), factory );
} catch ( Exception except ) { }
}
}
}
/**
* Register a serializer factory, keyed by the given
* method string.
*/
public static void registerSerializerFactory( SerializerFactory factory )
{
String method;
synchronized ( _factories ) {
method = factory.getSupportedMethod();
_factories.put( method, factory );
}
}
/**
* Register a serializer factory, keyed by the given
* method string.
*/
public static SerializerFactory getSerializerFactory( String method )
{
return (SerializerFactory) _factories.get( method );
}
/**
* Returns the method supported by this factory and used to register
* the factory. This call is required so factories can be added from
* a properties file by knowing only the class name. This method is
* protected, it is only required by this class but must be implemented
* in derived classes.
*/
protected abstract String getSupportedMethod();
/**
* Create a new serializer based on the {@link OutputFormat}.
* If this method is used to create the serializer, the {@link
* Serializer#setOutputByteStream} or {@link Serializer#setOutputCharStream}
* methods must be called before serializing a document.
*/
public abstract Serializer makeSerializer(OutputFormat format);
/**
* Create a new serializer, based on the {@link OutputFormat} and
* using the writer as the output character stream. If this
* method is used, the encoding property will be ignored.
*/
public abstract Serializer makeSerializer( Writer writer,
OutputFormat format );
/**
* Create a new serializer, based on the {@link OutputFormat} and
* using the output byte stream and the encoding specified in the
* output format.
*
* @throws UnsupportedEncodingException The specified encoding is
* not supported
*/
public abstract Serializer makeSerializer( OutputStream output,
OutputFormat format )
throws UnsupportedEncodingException;
}