Snapshot.java

/**
 * Copyright (C) 2009-2015 Dell, Inc.
 * See annotations for authorship information
 *
 * ====================================================================
 * 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 org.dasein.cloud.compute;

import org.dasein.cloud.Tag;
import org.dasein.cloud.Taggable;
import org.dasein.cloud.VisibleScope;

import javax.annotation.Nonnull;
import java.util.HashMap;
import java.util.Map;

public class Snapshot implements Taggable {
    private SnapshotState       currentState;
    private String              description;
    private String              name;
    private String              owner;
    private String              progress;
    private String              providerSnapshotId;
    private String              regionId;
    private int                 sizeInGb;
    private long                snapshotTimestamp;
    private Map<String, String> tags;
    private String              volumeId;
    private VisibleScope        visibleScope;

    public Snapshot() {
    }

    public boolean equals( Object ob ) {
        if( ob == null ) {
            return false;
        }
        if( ob == this ) {
            return true;
        }
        if( !getClass().getName().equals(ob.getClass().getName()) ) {
            return false;
        }
        Snapshot other = ( Snapshot ) ob;

        if( !owner.equals(other.owner) ) {
            return false;
        }
        if( !regionId.equals(other.regionId) ) {
            return false;
        }
        return providerSnapshotId.equals(other.providerSnapshotId);
    }

    public SnapshotState getCurrentState() {
        return currentState;
    }

    public String getName() {
        return name;
    }

    public String getOwner() {
        return owner;
    }

    public String getProviderSnapshotId() {
        return providerSnapshotId;
    }

    public String getRegionId() {
        return regionId;
    }

    public long getSnapshotTimestamp() {
        return snapshotTimestamp;
    }

    public String getVolumeId() {
        return volumeId;
    }

    public void setCurrentState( SnapshotState currentState ) {
        this.currentState = currentState;
    }

    public void setName( String name ) {
        this.name = name;
    }

    public void setOwner( String owner ) {
        this.owner = owner;
    }

    public void setProviderSnapshotId( String providerSnapshotId ) {
        this.providerSnapshotId = providerSnapshotId;
    }

    public void setRegionId( String regionId ) {
        this.regionId = regionId;
    }

    public void setSnapshotTimestamp( long snapshotTimestamp ) {
        this.snapshotTimestamp = snapshotTimestamp;
    }

    public void setVolumeId( String volumeId ) {
        this.volumeId = volumeId;
    }

    public String getDescription() {
        return description;
    }

    public String getProgress() {
        return progress;
    }

    public void setDescription( String description ) {
        this.description = description;
    }

    public void setProgress( String progress ) {
        this.progress = progress;
    }

    public int getSizeInGb() {
        return sizeInGb;
    }

    public void setSizeInGb( int sizeInGb ) {
        this.sizeInGb = sizeInGb;
    }


    public void addTag( Tag t ) {
        addTag(t.getKey(), t.getValue());
    }

    public void addTag( String key, String value ) {
        getTags().put(key, value);
    }

    public Object getTag( String tag ) {
        return getTags().get(tag);
    }

    public synchronized @Nonnull Map<String, String> getTags() {
        if( tags == null ) {
            tags = new HashMap<String, String>();
        }
        return tags;
    }

    public void setTag( @Nonnull String key, @Nonnull String value ) {
        getTags().put(key, value);
    }

    public synchronized void setTags( Map<String, String> properties ) {
        getTags().clear();
        getTags().putAll(properties);
    }

    public void setVisibleScope(VisibleScope visibleScope){
        this.visibleScope = visibleScope;
    }

    public VisibleScope getVisibleScope(){
        return visibleScope;
    }

    public String toString() {
        return ( name + " [" + providerSnapshotId + "]" );
    }
}