Class DefaultCallback
- All Implemented Interfaces:
Callback
- Direct Known Subclasses:
LinkExtractor
,TextExtractor
Callbacks can inherit from this class and forget about methods they are not interested in.
This class has a protected constructor. If you need an instance of this class, use
getInstance()
.
-
Field Summary
Fields inherited from interface it.unimi.dsi.parser.callback.Callback
EMPTY_CALLBACK_ARRAY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated.Receive notification of the content of a CDATA section.boolean
characters
(char[] textUnused, int offsetUnused, int lengthUnused, boolean flowBrokenUnused) Deprecated.Receive notification of character data inside an element.void
configure
(BulletParser parserUnused) Deprecated.Configure the parser for usage with this callback.void
Deprecated.Receive notification of the end of the document.boolean
endElement
(Element elementUnused) Deprecated.Receive notification of the end of an element.static DefaultCallback
Deprecated.Returns the singleton instance of the default callback.void
Deprecated.Receive notification of the beginning of the document.boolean
startElement
(Element elementUnused, Map<Attribute, MutableString> attrMapUnused) Deprecated.Receive notification of the start of an element.
-
Constructor Details
-
DefaultCallback
protected DefaultCallback()Deprecated.
-
-
Method Details
-
getInstance
Deprecated.Returns the singleton instance of the default callback.- Returns:
- the singleton instance of the default callback.
-
configure
Deprecated.Description copied from interface:Callback
Configure the parser for usage with this callback.When a callback is registered with a parser, it needs to set up the parser so that all data required by the callback is actually parsed. The configuration must be a monotone process—you can only set properties and add attribute types to be parsed.
-
startDocument
public void startDocument()Deprecated.Description copied from interface:Callback
Receive notification of the beginning of the document.The callback must use this method to reset its internal state so that it can be resued. It must be safe to invoke this method several times.
- Specified by:
startDocument
in interfaceCallback
-
startElement
Deprecated.Description copied from interface:Callback
Receive notification of the start of an element.For simple elements, this is the only notification that the callback will ever receive.
- Specified by:
startElement
in interfaceCallback
- Parameters:
elementUnused
- the element whose opening tag was found.attrMapUnused
- a map fromAttribute
s toMutableString
s.- Returns:
- true to keep the parser parsing, false to stop it.
-
endElement
Deprecated.Description copied from interface:Callback
Receive notification of the end of an element. Warning: unless specific decorators are used, in general a callback will just receive notifications for elements whose closing tag appears explicitly in the document.This method will never be called for element without closing tags, even if such a tag is found.
- Specified by:
endElement
in interfaceCallback
- Parameters:
elementUnused
- the element whose closing tag was found.- Returns:
- true to keep the parser parsing, false to stop it.
-
characters
public boolean characters(char[] textUnused, int offsetUnused, int lengthUnused, boolean flowBrokenUnused) Deprecated.Description copied from interface:Callback
Receive notification of character data inside an element.You must not write into
text
, as it could be passed around to many callbacks.flowBroken
will be true iff the flow was broken beforetext
. This feature makes it possible to extract quickly the text in a document without looking at the elements.- Specified by:
characters
in interfaceCallback
- Parameters:
textUnused
- an array containing the character data.offsetUnused
- the start position in the array.lengthUnused
- the number of characters to read from the array.flowBrokenUnused
- whether the flow is broken at the start oftext
.- Returns:
- true to keep the parser parsing, false to stop it.
-
cdata
Deprecated.Description copied from interface:Callback
Receive notification of the content of a CDATA section.CDATA sections in an HTML document are the result of meeting a
STYLE
orSCRIPT
element. In that case, the element will be passed as first argument.You must not write into
text
, as it could be passed around to many callbacks.- Specified by:
cdata
in interfaceCallback
- Parameters:
elementUnused
- the element enclosing the CDATA section, ornull
if the CDATA section was created with explicit markup.textUnused
- an array containing the character data.offsetUnused
- the start position in the array.lengthUnused
- the number of characters to read from the array.- Returns:
- true to keep the parser parsing, false to stop it.
-
endDocument
public void endDocument()Deprecated.Description copied from interface:Callback
Receive notification of the end of the document.- Specified by:
endDocument
in interfaceCallback
-