net.oneandone.troilus.java7.UpdateWithUnit Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of troilus-core-java7 Show documentation
There is a newer version: 0.18
/*
 * Copyright 1&1 Internet AG, https://github.com/1and1/
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.oneandone.troilus.java7;

import java.util.List;
import java.util.Map;
import java.util.Set;

import net.oneandone.troilus.ColumnName;

import com.google.common.collect.ImmutableMap;


/**
 * value-aware update query
 * @param  the query type
 */    
public interface UpdateWithUnit> extends Update {

    /**
     * @param entity  the entity to write
     * @return a cloned query instance with the modified behavior 
     */
    U entity(Object entity);
    
    /**
     * @param name  the column name 
     * @param value the value to add
     * @return a cloned query instance with the modified behavior
     */
    U value(String name, Object value);

    /**
     * @param nameValuePairsToAdd  the column name value pairs to add
     * @return a cloned query instance with the modified behavior
     */
    U values(ImmutableMap nameValuePairsToAdd);

    /**
     * @param name  the column name
     * @param value the value to add
     * @param  the name type
     * @return a cloned query instance with the modified behavior
     */
     U value(ColumnName name, T value);
    
    /**
     * @param name   the set column name
     * @param value  the set value to remove
     * @return a cloned query instance with the modified behavior
     */
    U removeSetValue(String name, Object value);

    /**
     * @param name   the set column name
     * @param value  the set value to remove
     * @param     the type
     * @return a cloned query instance with the modified behavior
     */
     U removeSetValue(ColumnName> name, T value);

    /**
     * @param name    the set column name
     * @param value   the set value to set
     * @return a cloned query instance with the modified behavior
     */
    U addSetValue(String name, Object value);

    /**
     * @param name    the set column name
     * @param value   the set value to set
     * @param      the type
     * @return a cloned query instance with the modified behavior
     */
     U addSetValue(ColumnName> name, T value);

    /**
     * @param name   the list column name
     * @param value  the list value to append
     * @return a cloned query instance with the modified behavior
     */
    U appendListValue(String name, Object value);

    /**
     * @param name   the list column name
     * @param value  the list value to append
     * @param     the type
     * @return a cloned query instance with the modified behavior
     */
     U appendListValue(ColumnName> name, T value);

    /**
     * @param name   the list column name
     * @param value  the list value to prepend
     * @return a cloned query instance with the modified behavior
     */
    U prependListValue(String name, Object value);

    /**
     * @param name   the list column name
     * @param value  the list value to prepend
     * @param     the type
     * @return a cloned query instance with the modified behavior
     */
     U prependListValue(ColumnName> name, T value);

    /**
     * @param name   the list column name
     * @param value  the list value to remove
     * @return a cloned query instance with the modified behavior
     */
    U removeListValue(String name, Object value);

    /**
     * @param name   the list column name
     * @param value  the list value to remove
     * @param     the type
     * @return a cloned query instance with the modified behavior
     */
     U removeListValue(ColumnName> name, T value);

    /**
     * @param name   the map column name 
     * @param key    the map key name
     * @param value  the map value
     * @return a cloned query instance with the modified behavior
     */
    U putMapValue(String name, Object key, Object value);
    
    /**
     * @param name   the map column name 
     * @param key    the map key name
     * @param value  the map value
     * @param     the key type
     * @param     the value type 
     * @return a cloned query instance with the modified behavior
     */
     U putMapValue(ColumnName> name, T key, V value);
}