001/* 
002 * JKNIV, whinstone one contract to access your database.
003 * 
004 * Copyright (C) 2017, the original author or authors.
005 *
006 * This library is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 2.1 of the License.
010 * 
011 * This library is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 * 
016 * You should have received a copy of the GNU Lesser General Public
017 * License along with this library; if not, write to the Free Software Foundation, Inc., 
018 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
019 */
020package net.sf.jkniv.whinstone.types;
021
022/**
023 * Convert or make the parser from Jdbc type to java object (class attribute)
024 * or vice-versa.
025 * 
026 * <p><b>Note:</b> the implementation must be thread-safe, null-safe and provides a constructor:
027 * {@code public MyConverter(String)}
028 * 
029 * @param <A>  the type of the class attribute
030 * @param <B>  the type of the jdbc data column
031 * 
032 * @author Alisson Gomes
033 * @since 0.6.0
034 */
035public interface Convertible<A, B>
036{
037    /**
038     * Convert attribute to jdbc format or type
039     * @param attribute the value of to be converted
040     * @return the value to be stored for jdbc driver
041     */
042    B toJdbc(A attribute);
043    
044    /**
045     * Convert the jdbc value to attribute format or type
046     * @param jdbc the value stored at database
047     * @return the value of attribute converted
048     */
049    A toAttribute(B jdbc);
050    
051    Class<A> getType();
052    
053    ColumnType getColumnType();
054}