xdev.util.ObjectConverter Maven / Gradle / Ivy

Go to download

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

XDEV Application Framework

There is a newer version: 6.0.2

package xdev.util;

/*-
 * #%L
 * XDEV Application Framework
 * %%
 * Copyright (C) 2003 - 2020 XDEV Software
 * %%
 * This program 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, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program 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 General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


/**
 * Object converter to convert an object into a specific type.
 * 
 * @param 
 *            the parser's type
 * 
 * @author XDEV Software
 * @since 3.1
 */
public interface ObjectConverter
{
	/**
	 * Returns the converted object of type T, or null if
	 * value is null.
	 * 
	 * If value cannot be converted to type T an
	 * {@link ObjectConversionException} is thrown.
	 * 
	 * @param value
	 *            the value to convert
	 * @return the converted object of type T, may be a new instance of type T,
	 *         or value itself if it is an instance of T
	 * @throws ObjectConversionException
	 *             if the parsing failed
	 */
	public T convert(Object value) throws ObjectConversionException;
}