geode-gfsh/src/main/java/org/apache/geode/management/internal/cli/converters/BaseStringConverter.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You 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.geode.management.internal.cli.converters;

import java.util.List;
import java.util.Set;

import org.springframework.shell.core.Completion;
import org.springframework.shell.core.Converter;
import org.springframework.shell.core.MethodTarget;

/**
 * Base class for all converters that use Strings
 */
public abstract class BaseStringConverter implements Converter<String> {

  public abstract String getConverterHint();

  public abstract Set<String> getCompletionValues();

  @Override
  public final boolean supports(Class<?> type, String optionContext) {
    return String.class.equals(type) && optionContext.contains(getConverterHint());
  }

  @Override
  public final String convertFromText(String value, Class<?> targetType, String optionContext) {
    return value;
  }

  @Override
  public final boolean getAllPossibleValues(List<Completion> completions, Class<?> targetType,
      String existingData, String optionContext, MethodTarget target) {
    Set<String> values = getCompletionValues();

    for (String v : values) {
      completions.add(new Completion(v));
    }

    return !completions.isEmpty();
  }
}