org.simpleframework.xml.Root Maven / Gradle / Ivy
/*
* Root.java July 2006
*
* Copyright (C) 2006, Niall Gallagher
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
package org.simpleframework.xml;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Retention;
/**
* This Root annotation is used to annotate classes that
* need to be serialized. Also, elements within an element list, as
* represented by the ElementList annotation need this
* annotation so that the element names can be determined. All other
* field or method names can be determined using the annotation and
* so the Root annotation is not needed for such objects.
*
* @author Niall Gallagher
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface Root {
/**
* This represents the name of the XML element. This is optional
* an is used when the name of the class is not suitable as an
* element name. If this is not specified then the name of the
* XML element will be the name of the class. If specified the
* class will be serialized and deserialized with the given name.
*
* @return the name of the XML element this represents
*/
public String name() default "";
/**
* This is used to determine whether the object represented
* should be parsed in a strict manner. Strict parsing requires
* that each element and attribute in the XML document match a
* field in the class schema. If an element or attribute does
* not match a field then the parsing fails with an exception.
* Setting strict parsing to false allows details within the
* source XML document to be skipped during deserialization.
*
* @return true if strict parsing is enabled, false otherwise
*/
public boolean strict() default true;
}