com.github.aliteralmind.codelet.alter

Class DefaultAlterGetterUtil

java.lang.Object

com.github.aliteralmind.codelet.alter.DefaultAlterGetterUtil

public class DefaultAlterGetterUtil
extends Object

Utilities related to default alterers.

Since:

0.1.0

Author:

Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. http://codelet.aliteralmind.com, https://github.com/aliteralmind/codelet

See Also:

CodeletBaseConfig.DEFAULT_ALTERERS_CLASS_NAME

Method Summary

Methods

Modifier and Type	Method and Description
static TextLineAlterer	get(CodeletInstance instance_forTypeOnly, String map_keyName, Appendable debugDest_ifNonNull) Get a default alterer from its name.
static TextLineAlterer[]	getAlterArrayWithDefaultAlterersAdded(CodeletType needed_defaultAlterType, List<TextLineAlterer> alter_list) Creates a new line-alter array with all default alterers placed after all provided alterers.
static TextLineAlterer[]	getAlterArrayWithDefaultAlterersAdded(CodeletType needed_defaultAlterType, TextLineAlterer the_onlyAlterer) Creates a new line-alter array with all default alterers placed after the provided alterer.
static TextLineAlterer[]	getDefaultAlterArray(CodeletType needed_defaultAlterType) Creates a new line-alter array with all defaults.
static LinkedHashMap<String,TextLineAlterer>	getMap(CodeletType needed_defaultAlterType) Get the map of default alterers.
static ArrayList<TextLineAlterer>	newEmptyArrayListWithDefaultInitCapacityPlus(CodeletType needed_defaultAlterType, int numToAdd_toDefaultMapSize) Creates a new list with a initial capacity equal to the default-alterers map, plus a number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public static final TextLineAlterer get(CodeletInstance instance_forTypeOnly,
                  String map_keyName,
                  Appendable debugDest_ifNonNull)

Get a default alterer from its name.

Parameters:

instance_forTypeOnly - May not be null.

map_keyName - Must be an existing key in the map.

Returns:

getMap(instance_forTypeOnly.getType()).get(map_keyName)

Throws:

NoSuchElementException - If map_keyName is not a key in the map.

getMap

public static final LinkedHashMap<String,TextLineAlterer> getMap(CodeletType needed_defaultAlterType)

Get the map of default alterers.

Parameters:

needed_defaultAlterType - May not be null.

Returns:

If needed_defaultAlterType is

• SOURCE_CODE: getDefaultAlterGetter()*.getForSourceCodelet()
• CONSOLE_OUT: getDefaultAlterGetter().getForCodeletDotOut()
• FILE_TEXT: getDefaultAlterGetter().getForFileTextlet()

Throws:

IllegalArgumentException - If needed_defaultAlterType is CodeletType.SOURCE_AND_OUT. Use SOURCE_CODE or CONSOLE_OUT instead.

DefaultAlterGetterException - If anything goes wrong when attempting to retrieve the map.

newEmptyArrayListWithDefaultInitCapacityPlus

public static final ArrayList<TextLineAlterer> newEmptyArrayListWithDefaultInitCapacityPlus(CodeletType needed_defaultAlterType,
                                                                      int numToAdd_toDefaultMapSize)

Creates a new list with a initial capacity equal to the default-alterers map, plus a number.

Parameters:

numToAdd_toDefaultMapSize - Should be greater than zero.

Returns:

(new ArrayList<TextLineAlterer>(
numToAdd_toDefaultMapSize + getMap(needed_defaultAlterType).size()))

Throws:

IllegalArgumentException - If numToAdd_toDefaultMapSize results in an initial capacity that is negative.

DefaultAlterGetterException - If anything goes wrong when attempting to retrieve the map or its size.

getDefaultAlterArray

public static final TextLineAlterer[] getDefaultAlterArray(CodeletType needed_defaultAlterType)

Creates a new line-alter array with all defaults.

Returns:

getAlterArrayWithDefaultAlterersAdded(needed_defaultAlterType,
new ArrayList<TextLineAlterer>(getMap(needed_defaultAlterType).size()))

getAlterArrayWithDefaultAlterersAdded

public static final TextLineAlterer[] getAlterArrayWithDefaultAlterersAdded(CodeletType needed_defaultAlterType,
                                                      TextLineAlterer the_onlyAlterer)

Creates a new line-alter array with all default alterers placed after the provided alterer.

Returns:

getAlterArrayWithDefaultAlterersAdded(needed_defaultAlterType,
new ArrayList<TextLineAlterer>(
Arrays.asList(new TextLineAlterer[]{the_onlyAlterer})))

getAlterArrayWithDefaultAlterersAdded

public static final TextLineAlterer[] getAlterArrayWithDefaultAlterersAdded(CodeletType needed_defaultAlterType,
                                                      List<TextLineAlterer> alter_list)

Creates a new line-alter array with all default alterers placed after all provided alterers.

Parameters:

needed_defaultAlterType - May not be null.

alter_list - May not be null, but may be empty or contain null elements.

Throws:

DefaultAlterGetterException - If anything goes wrong when attempting to retrieve the map, its entry iterator, or an entry.

See Also:

getDefaultAlterArray, getAlterArrayWithDefaultAlterersAdded