001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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     */
020    package org.sonar.api.batch.sensor.internal;
021    
022    import com.google.common.base.Preconditions;
023    import org.apache.commons.lang.builder.ToStringBuilder;
024    import org.apache.commons.lang.builder.ToStringStyle;
025    import org.sonar.api.batch.sensor.SensorStorage;
026    
027    import javax.annotation.Nullable;
028    
029    public abstract class DefaultStorable {
030    
031      protected transient final 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        Preconditions.checkNotNull(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    }