extensions/migration/src/main/java/org/apache/zest/migration/operation/RemoveProperty.java

/*
 * Copyright (c) 2009, Rickard Öberg. All Rights Reserved.
 *
 * 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.apache.zest.migration.operation;

import org.json.JSONException;
import org.json.JSONObject;
import org.apache.zest.migration.Migrator;
import org.apache.zest.migration.assembly.EntityMigrationOperation;
import org.apache.zest.spi.entitystore.helpers.StateStore;

/**
 * Remove a property. Downgrading this operation will reset
 * the property to the default value.
 */
public class RemoveProperty
    implements EntityMigrationOperation
{
    private String property;
    private String defaultValue;

    public RemoveProperty( String property, String defaultValue )
    {
        this.property = property;
        this.defaultValue = defaultValue;
    }

    @Override
    public boolean upgrade( JSONObject state, StateStore stateStore, Migrator migrator )
        throws JSONException
    {
        return migrator.removeProperty( state, property );
    }

    @Override
    public boolean downgrade( JSONObject state, StateStore stateStore, Migrator migrator )
        throws JSONException
    {
        return migrator.addProperty( state, property, defaultValue );
    }

    @Override
    public String toString()
    {
        return "Remove property " + property + ", default:" + defaultValue;
    }
}