001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program 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 3 of the License, or (at your option) any later version.
010 *
011 * This program 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 License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.batch.sensor.internal;
021
022import com.google.common.base.Preconditions;
023import javax.annotation.Nullable;
024import org.apache.commons.lang.builder.ToStringBuilder;
025import org.apache.commons.lang.builder.ToStringStyle;
026
027import static java.util.Objects.requireNonNull;
028
029public abstract class DefaultStorable {
030
031  protected final transient SensorStorage storage;
032  private transient boolean saved = false;
033
034  public DefaultStorable() {
035    this.storage = null;
036  }
037
038  public DefaultStorable(@Nullable SensorStorage storage) {
039    this.storage = storage;
040  }
041
042  public final void save() {
043    requireNonNull(this.storage, "No persister on this object");
044    Preconditions.checkState(!saved, "This object was already saved");
045    doSave();
046    this.saved = true;
047  }
048
049  protected abstract void doSave();
050
051  @Override
052  public String toString() {
053    return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_STYLE);
054  }
055
056}