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
027public abstract class DefaultStorable {
028
029  protected final transient SensorStorage storage;
030  private transient boolean saved = false;
031
032  public DefaultStorable() {
033    this.storage = null;
034  }
035
036  public DefaultStorable(@Nullable SensorStorage storage) {
037    this.storage = storage;
038  }
039
040  public final void save() {
041    Preconditions.checkNotNull(this.storage, "No persister on this object");
042    Preconditions.checkState(!saved, "This object was already saved");
043    doSave();
044    this.saved = true;
045  }
046
047  protected abstract void doSave();
048
049  @Override
050  public String toString() {
051    return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_STYLE);
052  }
053
054}