org.jibx.schema.attributes.AttributeBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jibx-schema Show documentation
JiBX schema code
There is a newer version: 1.4.2
/*
Copyright (c) 2007, Dennis M. Sosnoski
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of JiBX nor the names of its contributors may be used
   to endorse or promote products derived from this software without specific
   prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

package org.jibx.schema.attributes;

import org.jibx.schema.IComponent;
import org.jibx.schema.elements.SchemaBase;
import org.jibx.schema.validation.ValidationContext;

/**
 * Base class for schema attributes and attribute groups. This just provides
 * a link to the owning element, along with dummy implementations of the
 * validation methods.
 * 
 * @author Dennis M. Sosnoski
 */
public class AttributeBase implements IComponent
{
    /** Owning element. */
    private final SchemaBase m_owner;
    
    /**
     * Constructor.
     * 
     * @param owner owning element
     */
    protected AttributeBase(SchemaBase owner) {
        m_owner = owner;
    }

    /**
     * Get owning element.
     *
     * @return owning element (cannot be null)
     */
    public final SchemaBase getOwner() {
        return m_owner;
    }

    /**
     * Prevalidate component information. The prevalidation step is used to
     * check isolated aspects of a component, such as the settings for
     * enumerated values. This empty base class implementation should be
     * overridden by each subclass that requires prevalidation handling.
     * 
     * @param vctx validation context
     */
    public void prevalidate(ValidationContext vctx) {}
    
    /**
     * Validate component information. The validation step is used for checking
     * the interactions between components, such as name references to other
     * components. The {@link #prevalidate} method will always be called for
     * every component in the schema definition before this method is called for
     * any component. This empty base class implementation should be overridden
     * by each subclass that requires validation handling.
     * 
     * @param vctx validation context
     */
    public void validate(ValidationContext vctx) {}
}