org.apache.accumulo.core.iterators
public static class OptionDescriber.IteratorOptions extends Object
Modifier and Type | Field and Description |
---|---|
String |
description |
String |
name |
LinkedHashMap<String,String> |
namedOptions |
ArrayList<String> |
unnamedOptionDescriptions |
Constructor and Description |
---|
OptionDescriber.IteratorOptions(String name,
String description,
Map<String,String> namedOptions,
List<String> unnamedOptionDescriptions)
IteratorOptions holds the name, description, and option information for an iterator.
|
Modifier and Type | Method and Description |
---|---|
void |
addNamedOption(String name,
String description) |
void |
addUnnamedOption(String description) |
String |
getDescription() |
String |
getName() |
Map<String,String> |
getNamedOptions() |
List<String> |
getUnnamedOptionDescriptions() |
void |
setDescription(String description) |
void |
setName(String name) |
void |
setNamedOptions(Map<String,String> namedOptions) |
void |
setUnnamedOptionDescriptions(List<String> unnamedOptionDescriptions) |
public LinkedHashMap<String,String> namedOptions
public String name
public String description
public OptionDescriber.IteratorOptions(String name, String description, Map<String,String> namedOptions, List<String> unnamedOptionDescriptions)
name
- is the distinguishing name for the iterator or filterdescription
- is a description of the iterator or filternamedOptions
- is a map from specifically named options to their descriptions (null if unused) e.g., the AgeOffFilter requires a parameter called "ttl", so its
namedOptions = Collections.singletonMap("ttl", "time to live (milliseconds)")unnamedOptionDescriptions
- is a list of descriptions of additional options that don't have fixed names (null if unused). The descriptions are intended to describe a
category, and the user will provide parameter names and values in that category; e.g., the FilteringIterator needs a list of Filters intended to
be named by their priority numbers, so itsunnamedOptionDescriptions = Collections.singletonList("<filterPriorityNumber> <ageoff|regex|filterClass>")
public String getName()
public String getDescription()
public void setUnnamedOptionDescriptions(List<String> unnamedOptionDescriptions)
public void setName(String name)
public void setDescription(String description)
public void addUnnamedOption(String description)
Copyright © 2011–2015 The Apache Software Foundation. All rights reserved.