UnsetPreferenceAction.java

/*
 * Copyright (c) 2009-present the original author or authors.
 *
 * 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 com.planet57.gshell.commands.pref;

import java.util.prefs.Preferences;

import com.planet57.gshell.command.Command;
import com.planet57.gshell.command.CommandContext;
import com.planet57.gshell.util.cli2.Argument;

import javax.annotation.Nonnull;

/**
 * Unset a preference value.
 *
 * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
 * @since 2.0
 */
@Command(name = "pref/unset", description = "Unset a preference")
public class UnsetPreferenceAction
    extends PreferenceNodeActionSupport
{
  @Argument(index = 1, required = true, description = "Preference key", token = "KEY")
  private String key;

  @Override
  public Object execute(@Nonnull final CommandContext context) throws Exception {
    log.debug("Unsetting preference: {}", key);

    Preferences prefs = node();
    prefs.remove(key);
    prefs.sync();

    return null;
  }
}