HintCommands.java

package org.springframework.roo.classpath.operations;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Service;
import org.springframework.roo.shell.CliCommand;
import org.springframework.roo.shell.CliOption;
import org.springframework.roo.shell.CommandMarker;

/**
 * Shell commands for hinting services.
 * 
 * @author Ben Alex
 * @since 1.0
 */
@Component
@Service
public class HintCommands implements CommandMarker {

  @Reference
  private HintOperations hintOperations;

  @CliCommand(value = "hint", help = "Provides step-by-step hints and context-sensitive guidance.")
  public String hint(
      @CliOption(
          key = {"topic", ""},
          mandatory = false,
          unspecifiedDefaultValue = "",
          optionContext = "disable-string-converter,topics",
          help = "The topic for which advice should be provided. "
              + "Possible values are: `controllers`, `eclipse`, `entities`, `fields`, `finders`, `general`, "
              + "`mvc`, `persistence`, `relationships`, `repositories`, `services`, `start` and `topics`.") final String topic) {

    return hintOperations.hint(topic);
  }
}