com.avaje.ebeaninternal.server.persist.BindValues Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation
Ebean
There is a newer version: 2.8.1
/**
 * Copyright (C) 2006  Robin Bygrave
 * 
 * This file is part of Ebean.
 * 
 * Ebean 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 2.1 of the License, or
 * (at your option) any later version.
 *  
 * Ebean 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 Ebean; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA  
 */
package com.avaje.ebeaninternal.server.persist;

import java.util.ArrayList;

/**
 * Holds a list of bind values for binding to a PreparedStatement.
 */
public class BindValues {

    int commentCount;

    final ArrayList list = new ArrayList();
    
    /**
     * Create with a Binder.
     */
    public BindValues(){
    }
    
    /**
     * Return the number of bind values.
     */
    public int size() {
        return list.size() - commentCount;
    }
    
    /**
     * Add a bind value with its JDBC datatype.
     * 
     * @param value the bind value
     * @param dbType the type as per java.sql.Types
     */
    public void add(Object value, int dbType, String name){
        list.add(new Value(value, dbType, name));
    }
    
    public void addComment(String comment){
    	++commentCount;
        list.add(new Value(comment));
    }
    
    /**
     * List of bind values.
     */
    public ArrayList values() {
        return list;
    }
    
    /**
     * A Value has additionally the JDBC data type.
     */
    public static class Value {
        
        private final Object value;
        
        private final int dbType;
               
        private final String name;

        private final boolean isComment;
        
        /**
         * Create a comment. This is so that comments can be put into
         * the bind log.
         */
        public Value(String comment) {
            this.name = comment;
            this.isComment = true;
            value = null;
            dbType = 0;
        }
        
        
        /**
         * Create the value.
         */
        public Value(Object value, int dbType, String name) {
        	this.isComment = false;
            this.value = value;
            this.dbType = dbType;
            this.name = name;
        }
        
        /**
         * This is a comment for the bind log and NOT an actual bind value.
         */
        public boolean isComment() {
        	return isComment;
        }
        
        /**
         * Return the type as per java.sql.Types.
         */
        public int getDbType() {
            return dbType;
        }
        
        /**
         * Return the value.
         */
        public Object getValue() {
            return value;
        }
        
        /**
         * Return the property name.
         */
        public String getName() {
        	return name;
        }
        
        public String toString(){
            return ""+value;
        }
    }
}