org.apache.ws.commons.schema.extensions.ExtensionSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of XmlSchema Show documentation

Commons XMLSchema is a light weight schema object model that can be used to manipulate or generate a schema. It has a clean, easy to use API and can easily be integrated into an existing project since it has almost no dependencies on third party libraries.

There is a newer version: 1.4.5

Show newest version

/*
 * 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 org.apache.ws.commons.schema.extensions;

import org.apache.ws.commons.schema.XmlSchemaObject;
import org.w3c.dom.Node;


/**
 *  Interface for the extension serializer. The purpose of an instance
 * of this is to serialize the relevant custom object
 * and  generate   attribute/elementa desired . This custom object
 * may be stored in the metadata map
 * of the parent schema object. When to invoke a given serializer is a decision
 * taken by the extension registry
 */
public interface ExtensionSerializer {

     /**
     * serialize the given element
     * @param schemaObject  - Parent schema object.contains the extension
      * to be serialized
     * @param classOfType - The class of type to be serialized
     * @param domNode - the parent DOM Node that will ultimately be serialized. The XMLSchema
     * serialization mechanism is to create a DOM tree first and serialize it
     */
     public void serialize(XmlSchemaObject schemaObject,
                             Class classOfType,
                             Node domNode);
}