org.simpleframework.xml.core.Criteria Maven / Gradle / Ivy
/*
* Criteria.java December 2009
*
* Copyright (C) 2009, 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.core;
/**
* The Criteria object represents the criteria used to
* create an object and populate its methods and fields. This allows
* all deserialized information for a single object to be stored in
* a single location. All deserialized variables are accessible from
* the get method.
*
* @author Niall Gallagher
*/
interface Criteria {
/**
* This is used to get the Variable that represents
* a deserialized object. The variable contains all the meta
* data for the field or method and the value that is to be set
* on the method or field.
*
* @param name this is the name of the variable to be acquired
*
* @return this returns the named variable if it exists
*/
public Variable get(String name);
/**
* This is used to remove the Variable from this
* criteria object. When removed, the variable will no longer be
* used to set the method or field when the commit
* method is invoked.
*
* @param name this is the name of the variable to be removed
*
* @return this returns the named variable if it exists
*/
public Variable remove(String name);
/**
* This is used to create a Variable and set it for
* this criteria. The variable can be retrieved at a later stage
* using the name of the label. This allows for repeat reads as
* the variable can be used to acquire the labels converter.
*
* @param label this is the label used to create the pointer
* @param value this is the value of the object to be read
*/
public void set(Label label, Object value) throws Exception;
/**
* This is used to set the values for the methods and fields of
* the specified object. Invoking this performs the population
* of an object being deserialized. It ensures that each value
* is set after the XML element has been fully read.
*
* @param source this is the object that is to be populated
*/
public void commit(Object source) throws Exception;
}