Mercurial > hg > release > thermostat-0.15
view storage/core/src/main/java/com/redhat/thermostat/storage/core/Replace.java @ 1232:7936f09da466
Remove Put from public API
Reviewed-by: jerboaa
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-August/008042.html
author | Omair Majid <omajid@redhat.com> |
---|---|
date | Tue, 27 Aug 2013 11:50:35 -0400 |
parents | f790fc01d0bc |
children | cd020319d8ed |
line wrap: on
line source
/* * Copyright 2012, 2013 Red Hat, Inc. * * This file is part of Thermostat. * * Thermostat is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published * by the Free Software Foundation; either version 2, or (at your * option) any later version. * * Thermostat 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 Public License for more details. * * You should have received a copy of the GNU General Public License * along with Thermostat; see the file COPYING. If not see * <http://www.gnu.org/licenses/>. * * Linking this code with other modules is making a combined work * based on this code. Thus, the terms and conditions of the GNU * General Public License cover the whole combination. * * As a special exception, the copyright holders of this code give * you permission to link this code with independent modules to * produce an executable, regardless of the license terms of these * independent modules, and to copy and distribute the resulting * executable under terms of your choice, provided that you also * meet, for each linked independent module, the terms and conditions * of the license of that module. An independent module is a module * which is not derived from or based on this code. If you modify * this code, you may extend this exception to your version of the * library, but you are not obligated to do so. If you do not wish * to do so, delete this exception statement from your version. */ package com.redhat.thermostat.storage.core; import com.redhat.thermostat.storage.model.Pojo; import com.redhat.thermostat.storage.query.Expression; /** * Write operation which should be used if any existing record should get * updated with new values. It can be thought of as {@link Update} for * <strong>all</strong> properties of a record. * <p> * The only distinction to a regular {@link Update} is that if Replace is used * and the associated {@code where} expression yields no result, a * <strong>new</strong> record will be insterted into Storage. * <p> * The result of this operation is undefined if the {@code where} expression * matches more than one record in storage. * * @see Add * @see Remove * @see Update */ public interface Replace { /** * Sets the POJO that will be used to replace the value in storage. * * @param pojo the pojo to be put into the storage */ void setPojo(Pojo pojo); /** * Specifies what criteria to use to find the record to replace */ void where(Expression expression); /** * Applies this {@code Replace} operation to the storage. */ void apply(); }