org.jsimpledb.cli.cmd.Command Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsimpledb-cli Show documentation

JSimpleDB classes supporting command line interfaces.

There is a newer version: 3.6.1


/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package org.jsimpledb.cli.cmd;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.jsimpledb.SessionMode;

/**
 * Java annotation for classes that define custom {@link org.jsimpledb.cli.CliSession} commands.
 *
 * 
 * Annotated classes must extend {@link AbstractCommand}
 * and have a public constructor taking either zero parameters or a single {@link org.jsimpledb.cli.CliSession} parameter.
 * 
 *
 * @see AbstractCommand
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Command {

    /**
     * Get the {@link SessionMode}s supported by the annotated {@link org.jsimpledb.cli.cmd.AbstractCommand}.
     *
     * @return supported {@link SessionMode}s
     */
    SessionMode[] modes() default { SessionMode.CORE_API, SessionMode.JSIMPLEDB };
}