Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package io.github.amayaframework.options;
import com.github.romanqed.jfunc.Runnable1;
import com.github.romanqed.jfunc.Runnable2;
import java.util.Map;
import java.util.Set;
/**
* An interface extending {@link OptionSet} interface with basic option group operations.
*
* It includes the basic group operations: getGroup, setGroup, containsGroup, removeGroup.
*/
public interface GroupOptionSet extends OptionSet {
/**
* Gets the {@link OptionSet} instance associated with given group name.
*
* @param group the specified group name
* @return the {@link OptionSet} instance associated with group name or null
*/
OptionSet getGroup(String group);
/**
* Checks if set contains group with the specified name.
*
* @param group the specified group name
* @return true, if group exists, false otherwise
*/
boolean containsGroup(String group);
/**
* Sets given {@link OptionSet} instance to the specified group name.
*
* @param group the specified group name, must be non-null
* @param set the specified {@link OptionSet} instance, may be null
* @return previous associated instance, if it exists, null otherwise
*/
OptionSet setGroup(String group, OptionSet set);
/**
* Removes the specified group from set.
*
* @param group the specified group name
* @return associated {@link OptionSet} instance, if it exists, null otherwise
*/
OptionSet removeGroup(String group);
/**
* Gets the value associated with given key.
*
* Split key by 2 parts: group identifier and option key identifier.
* After that use group identifier to try access {@link OptionSet} instance related to requested group.
* If set can be accessed, gets value from it by option key.
*
*
* @param key the specified key qualifier
* @param the type of requested value
* @return the value associated with key or null
*/
@Override
T get(String key);
/**
* Treats option entry only as a key entry.
*
* The following heuristics are used:
*
*
if value is 'true', then result is true;
*
if value is 'false', then result if false;
*
otherwise, if value is null or any other reference, then result is true.
*
*
* Split key by 2 parts: group identifier and option key identifier.
* After that use group identifier to try access {@link OptionSet} instance related to requested group.
* If set can be accessed, gets value from it by option key.
*
*
* @param key the specified key
* @return false, if value is 'false', true otherwise
*/
@Override
boolean asKey(String key);
/**
* Treats option entry as a boolean value.
*
* The following heuristics are used:
*
*
if value is 'true', then result is true;
*
if value is 'false', then result is false;
*
if value is null, then result is false;
*
otherwise result is true.
*
*
* Split key by 2 parts: group identifier and option key identifier.
* After that use group identifier to try access {@link OptionSet} instance related to requested group.
* If set can be accessed, gets value from it by option key.
*
*
* @param key the specified key
* @return false, if value is 'false' or null, true otherwise
*/
@Override
boolean asBool(String key);
/**
* Checks if set contains the specified key.
*
* Split key by 2 parts: group identifier and option key identifier.
* After that use group identifier to try access {@link OptionSet} instance related to requested group.
* If set can be accessed, gets value from it by option key.
*
*
* @param key the specified key
* @return true, if key exists, false otherwise
*/
@Override
boolean contains(String key);
/**
* Sets given value to the specified key.
*
* Split key by 2 parts: group identifier and option key identifier.
* After that use group identifier to try access {@link OptionSet} instance related to requested group.
* If set can be accessed, gets value from it by option key.
*
*
* @param key the specified key, must be non-null
* @param value the specified value
* @return previous associated value, if it exists, null otherwise
*/
@Override
Object set(String key, Object value);
/**
* Removes the specified key from set.
*
* Split key by 2 parts: group identifier and option key identifier.
* After that use group identifier to try access {@link OptionSet} instance related to requested group.
* If set can be accessed, gets value from it by option key.
*
*
* @param key the specified key
* @return associated value, if it exists, null otherwise
*/
@Override
Object remove(String key);
/**
* Gets set contains all group names from this {@link OptionSet} instance.
*
* @return {@link Set} instance
*/
@Override
Set getKeys();
/**
* Gets map contains all group entries from this {@link OptionSet} instance.
*
* @return {@link Map} instance
*/
@Override
Map asMap();
/**
* Performs given action for each key in each group in this {@link GroupOptionSet} instance.
*
* @param action the action to be performed, must be non-null
*/
@Override
void forEach(Runnable1 action);
/**
* Performs given action for each key-value pair in each group in this {@link OptionSet} instance.
*
* @param action the action to be performed, must be non-null
*/
@Override
void forEach(Runnable2 action);
}
