com.threecrickets.sincerity

Class Shortcuts

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<String>

com.threecrickets.sincerity.Shortcuts

All Implemented Interfaces:

Iterable<String>, Collection<String>, List<String>

public class Shortcuts
extends AbstractList<String>

Shortcuts can be used by Sincerity commands to allow for simpler, more user-friendly access.

Shortcuts can be general-purpose, or can be of one or more "types" that define special usage for specific commands. For example, the "add" type is used by the "dependencies:add" command and the "attach" type is used by the "repositories:attach" command.

Shortcuts are defined per container, and are stored in a standard JVM properties file under "/configuration/sincerity/shortcuts.conf".

Author:

Tal Liron

See Also:

Container.getShortcuts()

Field Summary

Fields

Modifier and Type	Field and Description
static String	SHORTCUT_PREFIX
static int	SHORTCUT_PREFIX_LENGTH
static String	SHORTCUT_TYPE_SEPARATOR

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
Shortcuts(File file) Loads the shortcuts.

Method Summary

Modifier and Type	Method and Description
void	addArgument(String argument, List<String> arguments) Utility to add an arguments to a list of arguments while supporting recursive expansion of shortcuts.
String	get(int index)
String[]	get(String shortcut) Retrieves a shortcut if it exists.
List<String>	getByType(String type) All shortcut identifiers by type.
int	size()

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

SHORTCUT_PREFIX

public static final String SHORTCUT_PREFIX

See Also:

Constant Field Values

SHORTCUT_TYPE_SEPARATOR

public static final String SHORTCUT_TYPE_SEPARATOR

See Also:

Constant Field Values

SHORTCUT_PREFIX_LENGTH

public static final int SHORTCUT_PREFIX_LENGTH

Constructor Detail

Shortcuts

public Shortcuts(File file)
          throws SincerityException

Loads the shortcuts.

Parameters:

file - The database file (usually "/configuration/sincerity/shortcuts.conf")

Throws:

SincerityException - In case of an error

Method Detail

get

public String[] get(String shortcut)
             throws SincerityException

Retrieves a shortcut if it exists.

Parameters:

shortcut - The shortcut identifier

Returns:

The shortcut values

Throws:

SincerityException - In case of an error

getByType

public List<String> getByType(String type)

All shortcut identifiers by type.

Parameters:

type - The type

Returns:

The shortcut identifiers

addArgument

public void addArgument(String argument,
                        List<String> arguments)
                 throws SincerityException

Utility to add an arguments to a list of arguments while supporting recursive expansion of shortcuts.

Parameters:

argument - The argument to add

arguments - The list to which we should add arguments

Throws:

SincerityException - In case of an error

size

public int size()

Specified by:

size in interface Collection<String>

Specified by:

size in interface List<String>

Specified by:

size in class AbstractCollection<String>

get

public String get(int index)

Specified by:

get in interface List<String>

Specified by:

get in class AbstractList<String>