public class OpenSearchDescriptionDocument extends ExtensionPoint
Modifier and Type | Class and Description |
---|---|
class |
OpenSearchDescriptionDocument.Handler
XmlParser ElementHandler for
openSearchDesc:OpenSearchDescription |
static class |
OpenSearchDescriptionDocument.SyndicationRight
The SyndicationRight class defines constant values for syndication
rights types.
|
ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler
AbstractExtension.AttributesHandler
Modifier and Type | Field and Description |
---|---|
protected boolean |
adultContent
A boolean flag that must be set if the content provided is not suitable for
minors.
|
protected java.lang.String |
attribution
A list of all content sources or platforms that should be credited.
|
protected java.lang.String |
contact
An email address at which the developer can be reached.
|
protected java.lang.String |
description
A human readable text description of the search content provider.
|
protected java.lang.String |
developer
The developer or maintainer of the OpenSearch feed.
|
protected java.lang.String |
format
The XML schema used by the search engine specified by
url . |
protected java.lang.String |
image
A URL that identifies the location of a 64x64-pixel image that can be used
in association with this search engine.
|
protected java.lang.String |
longName
The name by which this search content provider is referred to in
hypertext links, etc.
|
protected java.lang.String |
sampleSearch
A search string that should be used when example searches are done against
this OpenSearch engine.
|
protected java.lang.String |
shortName
A brief name that will appear in UI elements that reference this
search content provider.
|
protected int |
syndicationRight
The degree to which the search results provided by this search engine can
be distributed.
|
protected java.lang.String |
tags
A space-delimited set of words that are used as keywords to identify and
categorize this search content.
|
protected java.lang.String |
url
The HTTP GET URL at which the search content can be found.
|
xmlBlob
localName, namespace
Constructor and Description |
---|
OpenSearchDescriptionDocument() |
OpenSearchDescriptionDocument(OpenSearchDescriptionDocument doc) |
Modifier and Type | Method and Description |
---|---|
void |
generate(XmlWriter w)
Generates XML.
|
boolean |
getAdultContent() |
java.lang.String |
getAttribution() |
java.lang.String |
getContact() |
java.lang.String |
getDescription() |
java.lang.String |
getDeveloper() |
java.lang.String |
getFormat() |
java.lang.String |
getImage() |
java.lang.String |
getLongName() |
java.lang.String |
getSampleSearch() |
java.lang.String |
getShortName() |
int |
getSyndicationRight() |
java.lang.String |
getTags() |
java.lang.String |
getUrl() |
void |
parse(ExtensionProfile extProfile,
java.io.Reader reader)
Parses XML.
|
void |
setAdultContent(boolean v) |
void |
setAttribution(java.lang.String v) |
void |
setContact(java.lang.String v) |
void |
setDescription(java.lang.String v) |
void |
setDeveloper(java.lang.String v) |
void |
setFormat(java.lang.String v) |
void |
setImage(java.lang.String v) |
void |
setLongName(java.lang.String v) |
void |
setSampleSearch(java.lang.String v) |
void |
setShortName(java.lang.String v) |
void |
setSyndicationRight(int v) |
void |
setTags(java.lang.String v) |
void |
setUrl(java.lang.String v) |
void |
validateConfiguration()
Validates that the OpenSearchDescriptionDocument has all required
properties.
|
addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, declareExtensions, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getHandler, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild, visitChildren
consumeAttributes, disableStrictValidation, enableStrictValidation, eq, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate
protected java.lang.String url
protected java.lang.String format
url
.protected java.lang.String shortName
protected java.lang.String longName
protected java.lang.String description
protected java.lang.String tags
protected java.lang.String image
protected java.lang.String sampleSearch
protected java.lang.String developer
protected java.lang.String contact
protected java.lang.String attribution
protected int syndicationRight
protected boolean adultContent
public OpenSearchDescriptionDocument()
public OpenSearchDescriptionDocument(OpenSearchDescriptionDocument doc)
public final java.lang.String getUrl()
public void setUrl(java.lang.String v)
public final java.lang.String getFormat()
public void setFormat(java.lang.String v)
public final java.lang.String getShortName()
public void setShortName(java.lang.String v)
public final java.lang.String getLongName()
public void setLongName(java.lang.String v)
public final java.lang.String getDescription()
public void setDescription(java.lang.String v)
public final java.lang.String getTags()
public void setTags(java.lang.String v)
public final java.lang.String getImage()
public void setImage(java.lang.String v)
public final java.lang.String getSampleSearch()
public void setSampleSearch(java.lang.String v)
public final java.lang.String getDeveloper()
public void setDeveloper(java.lang.String v)
public final java.lang.String getContact()
public void setContact(java.lang.String v)
public final java.lang.String getAttribution()
public void setAttribution(java.lang.String v)
public final int getSyndicationRight()
public void setSyndicationRight(int v)
public final boolean getAdultContent()
public void setAdultContent(boolean v)
public void generate(XmlWriter w) throws java.io.IOException
w
- output writerjava.io.IOException
public void validateConfiguration() throws ServiceConfigurationException
url
property,
which is dynamically generated based upon the feed that is queried.ServiceConfigurationException
public void parse(ExtensionProfile extProfile, java.io.Reader reader) throws java.io.IOException, ParseException
extProfile
- extension profilereader
- XML input streamjava.io.IOException
ParseException