On this page
$group.create()
Create a new instance of a group tool.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | GroupTool | An instance of a group tool. |
$group.init()
Initialize a group tool.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | void | - |
$group.groupNames()
Return a set of group names.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | java.util.Set | A set of group names. |
$group.contains(groupName)
Test whether a group name is contained in a set of group names.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | groupName | java.lang.String | A group name. |
| Return | - | - | True if the group name is contained in a set of group names, otherwise false. |
$group.put(groupName, object)
Add an object into a group.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | groupName | java.lang.String | A group name. |
| object | java.lang.Object | An object being added. | |
| Return | - | void | - |
$group.get(groupName)
Return a list of group objects.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | groupName | java.lang.String | A group name. |
| Return | - | java.util.List | A list of group objects. |
$group.remove(groupName)
Remove a group from the specified group name.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | groupName | java.lang.String | A group name. |
| Return | - | java.util.List | A list of group objects previously associated with a specified group name, or null if there is no group corresponding to the key. |
$group.removeAll()
Remove all groups.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | void |
$group.clear()
Remove all mappings.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | void | - |