Uses of Class
eu.bandm.tools.d2d2.model.Definition

Packages that use Definition

Package	Description
eu.bandm.tools.d2d2.base	D2d allows to write valid XML documents directly in the creative flow of authoring, with minimum typographic noise.
eu.bandm.tools.d2d2.model	Umod main model class: This is the internal model for the d2d text type definitions.
eu.bandm.tools.d2d2.parser2
eu.bandm.tools.d2d2.rt	Umod main model class: This is a model for the results of d2d text parsing.

Uses of Definition in eu.bandm.tools.d2d2.base

Fields in eu.bandm.tools.d2d2.base declared as Definition

Modifier and Type	Field	Description
protected Definition	Text2Udom.meta_assumedXsltOutput
protected Definition	Text2Udom.meta_expected
protected Definition	Text2Udom.meta_kind
protected Definition	Text2Udom.meta_location
protected Definition	Text2Udom.meta_messageText
protected Definition	Text2Udom.meta_parsingError
protected Definition	Text2Udom.meta_skipped
protected Definition	Text2Udom.meta_tag
protected Definition	Text2Udom.meta_warning

Fields in eu.bandm.tools.d2d2.base with type parameters of type Definition

Modifier and Type	Field	Description
protected Set<Definition>	Udom2Sax.attributesDone	All those definitions the content of which (under the currently written node) have already been written out as attributes, and therefore do not need further processing.
protected Map<DefInstance,Definition>	UserdocInstantiated.defi2rewritten
protected final PreimageMap<Definition,String>	UserdocUninstantiated.defs2tag	Maps every found definition to its tag String.
protected final PreimageMap<Definition,String>	UserdocUninstantiated.defs2tag_global	Sum of UserdocUninstantiated.defs2tag over all modules.
protected Map<String,Definition>	XsltInstance.CollectAllElements.found	All Definitions reachable from the entry definition given to XsltInstance.CollectAllElements.findTopLevel(eu.bandm.tools.d2d2.model.Definition) and selected for direct notation.
protected Map<Definition,Map<ImportContext,Classifier.Instance>>	Classifier.instances
static final Predicate<Definition>	Navigate.isPublicRegExp	Returns whether a definition is of reg exp type (tags or chars) and has been defined as "public".
protected Set<Definition>	Def2Dtd.needed
static final Set<Definition>	Udom2Sax.NO_ATTRIBUTES
protected Set<Definition>	XsltInstance.CollectAllElements.notAccessible	All Definitions reachable from the entry definition given to XsltInstance.CollectAllElements.findTopLevel(eu.bandm.tools.d2d2.model.Definition) and not selected for direct notation.
protected Multimap<Definition,Definition>	UserdocInstantiated.uses	Maps all definitions (=on the left side) to those referred to by references in their expression )=on the right side).
protected Multimap<Definition,Definition>	UserdocInstantiated.uses	Maps all definitions (=on the left side) to those referred to by references in their expression )=on the right side).
protected Set<Definition>	Def2Dtd.visited
protected Set<Definition>	XsltInstance.CollectAllElements.visited	For to visit each definitions only once.

Methods in eu.bandm.tools.d2d2.base that return Definition

Modifier and Type	Method	Description
static @Opt Definition	Navigate.findInDefinitions(Module mod, String name)	Look for a definition in a module, including local defs.
static @Opt Definition	Navigate.findInDefinitions(Module mod, String[] names)	Look for a definition in a module, including local defs.
protected @Opt Definition	Dtd2Def.Phase1.globalDefForAtt(String name, DTM.Attribute attdef)	Construct a common d2d tag element definition for a given attribute.
protected Definition	Text2Udom.loadMetaDefinition(Map<String,Definition> defs, String name)	Find the definition from the loaded metamodule.
protected Definition	Dtd2Def.Phase1.makeAttribute(SourceItem context, String name, DTM.Attribute att)	Create a new d2d-definition for a dtd attribute value.
protected Definition	CharParserPrepare.rawDef(Definition def)

Methods in eu.bandm.tools.d2d2.base with parameters of type Definition

Modifier and Type	Method	Description
protected boolean	Text2Udom.accept_superfluous_end_tag(String tag, boolean defIsEmpty, Definition def, Location<String> startLoc)	Lets the scanner accept and discard an end tag, either normal or forced or by a parenthesis character.
void	Def2Xslt3.action(Definition def)
void	Navigate.CharSetCalc.action(Definition x)	All definitions which are not CharsRegExp are NOT a character set.
void	XsltInstance.CollectAllElements.action(Definition d)	Is matched by definitions which are neither Tags- nor Chars-RegExps.
protected void	Reducer.addToContext(Definition newdef, String kind)	Add Definition (Enum or Tags or Chars Parser) to currentscope (either to Module or (as a local definition) to a definition).
protected void	XsltInstance.CollectAllElements.classify(Definition t)	Consider the tag of the Definition (with xml_kind==element) for being directly referrable in an xslt template.
protected void	Reducer.constructMangledXmlTag(Location<XMLDocumentIdentifier> loc, Definition def)	Is called for any definition: Local definitions first apply name mangling.
static Reference	Navigate.coResolve(Definition def)	Delivers a resolved reference expression which points to the given definition.
protected Classifier.Instance	Classifier.createNewInstance(ImportContext ic, Definition raw)	non-substituted case.
protected void	Reducer.defineXmlNamespaceTag(Location<XMLDocumentIdentifier> loc, Definition def, String qname)	D2d only knows the combination "non-empty prefix and non-empty uri", or "empty prefix and empty uri".
protected String	UserdocInstantiated.defrw2minUniqueName(Definition def)
protected String	UserdocInstantiated.defrw2tooltip(Definition defrw)
protected boolean	Classifier.equivalent(Definition def1, Definition def2)
protected @Opt Classifier.Instance	Classifier.findInstance(Definition raw, ImportContext ic)
protected Map<ImportContext,Classifier.Instance>	Classifier.findInstances(Definition raw)
void	Udom2Sax.findPostProc(Definition def)
protected String	Udom2Sax.getCharOnly(Definition x, ResultContainer c)
protected void	Text2Udom.ignore_superfluous_end_tag(String tag, boolean defIsEmpty, Definition def, Location<String> startLoc)	Called after an empty tag, a parser or an enum have been consumed.
static void	Text2Udom.insertPlainChars(ResultingStructure host, Definition tag, String chars)	Aux function to insert synthesized character data in the output, which is NOT contained in the source, e.g.
static boolean	Navigate.isEmptyXRegExp(Definition def)	Returns whether a definition is of reg exp type (tags or chars) and has empty contents.
protected boolean	Text2Udom.isXsltDef(Definition def)	Whether a definition is an xslt element.
protected void	UserdocInstantiated.listUsage(Definition defrw)
protected Element_a	UserdocInstantiated.makeJumpTo(Definition def)
protected void	Def2Dtd.markNeeded(Definition def)
protected void	Navigate.VisitReachable.markToDo(Definition def)	Enter the definition into the to-do-set, if not already visited.
T	Navigate.VisitReachable.process(Definition def)	Process all definitions and expressions reachable from one particular definition.
protected Classifier.Instance	Classifier.provideInstance(Definition raw, ImportContext ic)
protected Definition	CharParserPrepare.rawDef(Definition def)
protected Module	CharParserPrepare.rawMod(Definition def)
static void	PostProcessor.removeAll(ResultingStructure udom, Definition tag)	Auxiliary function to remove all resulting sub-structures with the given tag.
protected void	UserdocUninstantiated.renderOneDef(Module module, String modulename, Definition def)	Generate all text for one particular definition in the main text body.
protected String	Userdoc.showCategory_long(Definition def)
protected static String	Userdoc.showCategory_short(Definition def)	Short text = the keyword in the d2d definition format, which gives the kind of a definition.
protected void	CharacterParser.subElement(Definition def, Expression rule)	Called when reaching a ParseParticle, a CharsRegExp or an Enumeration, which all lead to wrapping the parsing result into a Result object with this definition as its tag.
protected void	XsltInstance.CollectAllElements.takeDiscard(String tag, Definition take, Definition discard)	Puts one argument into the XsltInstance.CollectAllElements.found and the other in the XsltInstance.CollectAllElements.notAccessible set.
protected void	Def2Dtd.translate(Definition def)	Treat tags regexp and chars regexp differently.

Method parameters in eu.bandm.tools.d2d2.base with type arguments of type Definition

Modifier and Type	Method	Description
protected Definition	Text2Udom.loadMetaDefinition(Map<String,Definition> defs, String name)	Find the definition from the loaded metamodule.
protected @Opt Element_table	Userdoc.makeDocuTable(Set<Module> modules, Predicate<Definition> filter)	Show for which raw definitions which documentation and transformation entries exist.

Constructor parameters in eu.bandm.tools.d2d2.base with type arguments of type Definition

Modifier	Constructor	Description
	AttributeCollector(NonNullMap<Definition,Boolean> atts, MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg)	Only constructor.

Uses of Definition in eu.bandm.tools.d2d2.model

Subclasses of Definition in eu.bandm.tools.d2d2.model

Modifier and Type	Class	Description
class	CharsRegExp	Generated by umod; model author's documentation MISSING.
class	Enumeration	Generated by umod; model author's documentation MISSING.
class	TagsRegExp	Generated by umod; model author's documentation MISSING.
class	XRegExp	Generated by umod; model author's documentation MISSING.

Fields in eu.bandm.tools.d2d2.model declared as Definition

Modifier and Type	Field	Description
protected Definition	DefInstance.raw	Generated by umod; model author's documentation MISSING.
protected @Opt Definition	Reference.resolved	Generated by umod; model author's documentation MISSING.

Fields in eu.bandm.tools.d2d2.model with type parameters of type Definition

Modifier and Type	Field	Description
protected NonNullMap<String,Definition>	Module.definitions	Generated by umod; model author's documentation MISSING.
protected NonNullMap<Definition,DefInstance>	ResolvedModule.defInstances	Generated by umod; model author's documentation MISSING.
static final NonNullMap<String,Definition>	TagsRegExp.emptyLocals
static final Function<Definition,Boolean>	Definition.get_definedAsLocal	Deprecated. Use new '::' method reference instead.
static final Function<Module,NonNullMap<String,Definition>>	Module.get_definitions	Deprecated. Use new '::' method reference instead.
static final Function<ResolvedModule,NonNullMap<Definition,DefInstance>>	ResolvedModule.get_defInstances	Deprecated. Use new '::' method reference instead.
static final Function<Definition,@Opt String>	Definition.get_editpragmas	Deprecated. Use new '::' method reference instead.
static final Function<Definition,Boolean>	Definition.get_isgeneric	Deprecated. Use new '::' method reference instead.
static final Function<Definition,Boolean>	Definition.get_ispublic	Deprecated. Use new '::' method reference instead.
static final Function<TagsRegExp,NonNullMap<String,Definition>>	TagsRegExp.get_localdefs	Deprecated. Use new '::' method reference instead.
static final Function<Definition,@Opt String>	Definition.get_postproc	Deprecated. Use new '::' method reference instead.
static final Function<DefInstance,Definition>	DefInstance.get_raw	Deprecated. Use new '::' method reference instead.
static final Function<Reference,@Opt Definition>	Reference.get_resolved	Deprecated. Use new '::' method reference instead.
static final Function<XRegExp,@Opt NonNullMap<Definition,Boolean>>	XRegExp.get_xattributes	Deprecated. Use new '::' method reference instead.
static final Function<Definition,XmlKind>	Definition.get_xml_kind	Deprecated. Use new '::' method reference instead.
static final Function<Definition,@Opt String>	Definition.get_xml_src_tag	Deprecated. Use new '::' method reference instead.
static final Function<Definition,@Opt NamespaceName>	Definition.get_xml_tag	Deprecated. Use new '::' method reference instead.
static final Function<Definition,Boolean>	Definition.get_xml_trimmed	Deprecated. Use new '::' method reference instead.
static final Function<Definition,@Opt String>	Definition.get_xml_value	Deprecated. Use new '::' method reference instead.
protected NonNullMap<String,Definition>	TagsRegExp.localdefs	Generated by umod; model author's documentation MISSING.
protected @Opt NonNullMap<Definition,Boolean>	XRegExp.xattributes	Lists all sub-expressions to realize as XML attributes, and whether optional.(transient cache) (This definition has been created by UMod from the source at SYSTEM "D2d.umod":244.9-245.9, see this pretty print.) The type of this field is NonNullMap<Definition(never null),java.lang.Boolean(never null)>(maybe null) Its value defaults to null.

Methods in eu.bandm.tools.d2d2.model that return Definition

Modifier and Type	Method	Description
Definition	Definition.doclone()	Clones this object.
Definition	__SAX_Parser.fill_Definition(Object res)
Definition	DefInstance.get_raw()	Generated by umod; model author's documentation MISSING.
@Opt Definition	Reference.get_resolved()	Generated by umod; model author's documentation MISSING.
Definition	Definition.initFrom(Object o0)	Copies values of all common fields from the argument.
Definition	__SAX_Parser.matchSAX_Definition()

Methods in eu.bandm.tools.d2d2.model that return types with arguments of type Definition

Modifier and Type	Method	Description
static Pattern<Definition>	Definition.get_definedAsLocal(Pattern<? super Boolean> p)	Lifts a pattern which matches the field value to one which matches this whole object.
NonNullMap<String,Definition>	Module.get_definitions()	Generated by umod; model author's documentation MISSING.
NonNullMap<Definition,DefInstance>	ResolvedModule.get_defInstances()	Generated by umod; model author's documentation MISSING.
static Pattern<Definition>	Definition.get_editpragmas(Pattern<? super @Opt String> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<Definition>	Definition.get_isgeneric(Pattern<? super Boolean> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<Definition>	Definition.get_ispublic(Pattern<? super Boolean> p)	Lifts a pattern which matches the field value to one which matches this whole object.
NonNullMap<String,Definition>	TagsRegExp.get_localdefs()	Generated by umod; model author's documentation MISSING.
static Pattern<Definition>	Definition.get_postproc(Pattern<? super @Opt String> p)	Lifts a pattern which matches the field value to one which matches this whole object.
@Opt NonNullMap<Definition,Boolean>	XRegExp.get_xattributes()	Lists all sub-expressions to realize as XML attributes, and whether optional.(transient cache) (This definition has been created by UMod from the source at SYSTEM "D2d.umod":244.9-245.9, see this pretty print.) Generated getter method.
static Pattern<Definition>	Definition.get_xml_kind(Pattern<? super XmlKind> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<Definition>	Definition.get_xml_src_tag(Pattern<? super @Opt String> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<Definition>	Definition.get_xml_tag(Pattern<? super @Opt NamespaceName> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<Definition>	Definition.get_xml_trimmed(Pattern<? super Boolean> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<Definition>	Definition.get_xml_value(Pattern<? super @Opt String> p)	Lifts a pattern which matches the field value to one which matches this whole object.
protected NonNullMap<Definition,Boolean>	__SAX_Parser.parse_11()
protected NonNullMap<String,Definition>	__SAX_Parser.parse_12()
protected NonNullMap<String,Definition>	__SAX_Parser.parse_4()
protected NonNullMap<Definition,DefInstance>	__SAX_Parser.parse_6()
static Pattern<Definition>	__Patterns.term_Definition(Pattern<? super SourceItem> superpattern, Pattern<? super Boolean> p_isgeneric, Pattern<? super Boolean> p_ispublic, Pattern<? super Boolean> p_definedAsLocal, Pattern<? super @Opt String> p_postproc, Pattern<? super XmlKind> p_xml_kind, Pattern<? super @Opt String> p_xml_src_tag, Pattern<? super @Opt NamespaceName> p_xml_tag, Pattern<? super @Opt String> p_xml_value, Pattern<? super Boolean> p_xml_trimmed, Pattern<? super @Opt String> p_editpragmas)

Methods in eu.bandm.tools.d2d2.model with parameters of type Definition

Modifier and Type	Method	Description
protected void	__Formatter.action(Definition el)
void	__SAX_Writer.action(Definition e0)
protected void	CoRewrite.action(Definition e0)
protected void	Dump.action(Definition e0)
protected void	MATCH_ONLY_00.action(Definition e0)
protected void	Match.action(Definition e0)
protected void	Rewrite.action(Definition e0)
protected void	SinglePhase.action(Definition e0)
boolean	ResolvedModule.containsKey_defInstances(Definition key0)	Convenience un-Currying method.
protected void	Dump.descend(Definition e0)
protected void	Match.descend(Definition e0)
void	__SAX_Writer.dumpfields(Definition e0)
void	__SAX_Parser.XMLPARSER_Definition.fillFields(Definition newobj)
void	MATCH_ONLY_00.match(Definition e0)
void	__SAX_Parser.XMLPARSER_Definition.parsefields(Definition newobj)
protected void	Match.post(Definition e0)
protected void	Match.pre(Definition e0)
protected void	Dump.printscalars(Definition e0)
void	Module.put_definitions(String key0, Definition value)	Convenience un-Currying method. Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
void	ResolvedModule.put_defInstances(Definition key0, DefInstance value)	Convenience un-Currying method. Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
void	TagsRegExp.put_localdefs(String key0, Definition value)	Convenience un-Currying method. Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
protected void	CoRewrite.rewriteFields(Definition clone)
protected void	Rewrite.rewriteFields(Definition clone)
boolean	DefInstance.set_raw(Definition val)	Generated by umod; model author's documentation MISSING.
boolean	Reference.set_resolved(@Opt Definition val)	Generated by umod; model author's documentation MISSING.
protected Format	__Formatter.toFormat(Definition el)

Method parameters in eu.bandm.tools.d2d2.model with type arguments of type Definition

Modifier and Type	Method	Description
static Pattern<Object>	__Patterns.cast_Definition(Pattern<? super Definition> p)
static Pattern<Module>	Module.get_definitions(Pattern<? super NonNullMap<String,Definition>> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<ResolvedModule>	ResolvedModule.get_defInstances(Pattern<? super NonNullMap<Definition,DefInstance>> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<TagsRegExp>	TagsRegExp.get_localdefs(Pattern<? super NonNullMap<String,Definition>> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<DefInstance>	DefInstance.get_raw(Pattern<? super Definition> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<Reference>	Reference.get_resolved(Pattern<? super @Opt Definition> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<XRegExp>	XRegExp.get_xattributes(Pattern<? super @Opt NonNullMap<Definition,Boolean>> p)	Lifts a pattern which matches the field value to one which matches this whole object.
boolean	Module.set_definitions(NonNullMap<String,Definition> val)	Generated by umod; model author's documentation MISSING.
boolean	ResolvedModule.set_defInstances(NonNullMap<Definition,DefInstance> val)	Generated by umod; model author's documentation MISSING.
boolean	TagsRegExp.set_localdefs(NonNullMap<String,Definition> val)	Generated by umod; model author's documentation MISSING.
boolean	XRegExp.set_xattributes(@Opt NonNullMap<Definition,Boolean> val)	Lists all sub-expressions to realize as XML attributes, and whether optional.(transient cache) (This definition has been created by UMod from the source at SYSTEM "D2d.umod":244.9-245.9, see this pretty print.) Updates the (mutable) instance destructively.
static Pattern<Enumeration>	__Patterns.term_Enumeration(Pattern<? super Definition> superpattern, Pattern<? super NonNullList<String>> p_sourceOrder, Pattern<? super NonNullMap<String,Integer>> p_items, Pattern<? super NonNullMap<Integer,NonNullSet<String>>> p_reverse, Pattern<? super NonNullMap<Integer,String>> p_repr, Pattern<? super EnumRep> p_xml_representation, Pattern<? super Boolean> p_xml_emptystructs, Pattern<? super NonNullMap<Integer,NonNullMap<String,NonNullList<LocString>>>> p_itemDocu)
static Pattern<XRegExp>	__Patterns.term_XRegExp(Pattern<? super Definition> superpattern, Pattern<? super Expression> p_value, Pattern<? super @Opt NonNullMap<Definition,Boolean>> p_xattributes, Pattern<? super @Opt Object> p_manglingRule)

Constructors in eu.bandm.tools.d2d2.model with parameters of type Definition

Modifier	Constructor	Description
	DefInstance(Definition raw, String representingKey)	Constructor defined according to directive »C 0/..«.

Uses of Definition in eu.bandm.tools.d2d2.parser2

Methods in eu.bandm.tools.d2d2.parser2 with parameters of type Definition

Modifier and Type	Method	Description
protected static void	Parser2.addToContainer(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, SourceItem currentScope, Definition newdef, String kind)	Add Definition (Enum or Tags or Chars Parser) to currentscope (either to Module or (as a local definition) to a definition).

Uses of Definition in eu.bandm.tools.d2d2.rt

Fields in eu.bandm.tools.d2d2.rt declared as Definition

Modifier and Type	Field	Description
protected Definition	State_singleton.def	Generated by umod; model author's documentation MISSING.
protected Definition	ResultingStructure.tag	Generated by umod; model author's documentation MISSING.

Fields in eu.bandm.tools.d2d2.rt with type parameters of type Definition

Modifier and Type	Field	Description
protected Multimap<Definition,ResultingStructure>	ResultingStructure.assoc	Generated by umod; model author's documentation MISSING.
static final Function<ResultingStructure,Multimap<Definition,ResultingStructure>>	ResultingStructure.get_assoc	Deprecated. Use new '::' method reference instead.
static final Function<State_singleton,Definition>	State_singleton.get_def	Deprecated. Use new '::' method reference instead.
static final Function<ResultingStructure,Definition>	ResultingStructure.get_tag	Deprecated. Use new '::' method reference instead.

Methods in eu.bandm.tools.d2d2.rt that return Definition

Modifier and Type	Method	Description
Definition	State_singleton.get_def()	Generated by umod; model author's documentation MISSING.
Definition	ResultingStructure.get_tag()	Generated by umod; model author's documentation MISSING.

Methods in eu.bandm.tools.d2d2.rt that return types with arguments of type Definition

Modifier and Type	Method	Description
Multimap<Definition,ResultingStructure>	ResultingStructure.get_assoc()	Generated by umod; model author's documentation MISSING.

Methods in eu.bandm.tools.d2d2.rt with parameters of type Definition

Modifier and Type	Method	Description
protected void	MATCH_ONLY_00.action(Definition e0)
boolean	State_singleton.set_def(Definition val)	Generated by umod; model author's documentation MISSING.
boolean	ResultingStructure.set_tag(Definition val)	Generated by umod; model author's documentation MISSING.

Method parameters in eu.bandm.tools.d2d2.rt with type arguments of type Definition

Modifier and Type	Method	Description
static Pattern<ResultingStructure>	ResultingStructure.get_assoc(Pattern<? super Multimap<Definition,ResultingStructure>> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<State_singleton>	State_singleton.get_def(Pattern<? super Definition> p)	Lifts a pattern which matches the field value to one which matches this whole object.
static Pattern<ResultingStructure>	ResultingStructure.get_tag(Pattern<? super Definition> p)	Lifts a pattern which matches the field value to one which matches this whole object.
boolean	ResultingStructure.set_assoc(Multimap<Definition,ResultingStructure> val)	Generated by umod; model author's documentation MISSING.

Constructors in eu.bandm.tools.d2d2.rt with parameters of type Definition

Modifier	Constructor	Description
	ResultingStructure(Location<String> location, Definition tag)	Constructor defined according to directive »C 0/..«.
	State_singleton(@Opt State predec, ResultContainer result, boolean inxslt, Reference ref, Definition def, Expression rule)	Constructor defined according to directive »C 0/..«.
	State_singleton(ResultContainer result, Reference ref, Definition def, Expression rule)	Constructor with minimal set of arguments, is supplied automatically by the umod compiler, not explicitly by the user.