Add documentation to ListProfiles command

This commit is contained in:
Paul Schaub 2023-04-17 14:04:06 +02:00
parent 7e12da400b
commit 8a9f535531
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311

View file

@ -8,8 +8,18 @@ import sop.Profile;
import java.util.List; import java.util.List;
/**
* Subcommand to list supported profiles of other subcommands.
*/
public interface ListProfiles { public interface ListProfiles {
/**
* Provide the name of the subcommand for which profiles shall be listed.
* The returned list of profiles MUST NOT contain more than 4 entries.
*
* @param command command name (e.g. <pre>generate-key</pre>)
* @return list of profiles.
*/
List<Profile> subcommand(String command); List<Profile> subcommand(String command);
} }