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.ExtensionHandlerAbstractExtension.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 String |
attribution
A list of all content sources or platforms that should be credited.
|
protected String |
contact
An email address at which the developer can be reached.
|
protected String |
description
A human readable text description of the search content provider.
|
protected String |
developer
The developer or maintainer of the OpenSearch feed.
|
protected String |
format
The XML schema used by the search engine specified by
url. |
protected String |
image
A URL that identifies the location of a 64x64-pixel image that can be used
in association with this search engine.
|
protected String |
longName
The name by which this search content provider is referred to in
hypertext links, etc.
|
protected String |
sampleSearch
A search string that should be used when example searches are done against
this OpenSearch engine.
|
protected 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 String |
tags
A space-delimited set of words that are used as keywords to identify and
categorize this search content.
|
protected String |
url
The HTTP GET URL at which the search content can be found.
|
xmlBloblocalName, namespace| Constructor and Description |
|---|
OpenSearchDescriptionDocument() |
OpenSearchDescriptionDocument(OpenSearchDescriptionDocument doc) |
| Modifier and Type | Method and Description |
|---|---|
void |
generate(XmlWriter w)
Generates XML.
|
boolean |
getAdultContent() |
String |
getAttribution() |
String |
getContact() |
String |
getDescription() |
String |
getDeveloper() |
String |
getFormat() |
String |
getImage() |
String |
getLongName() |
String |
getSampleSearch() |
String |
getShortName() |
int |
getSyndicationRight() |
String |
getTags() |
String |
getUrl() |
void |
parse(ExtensionProfile extProfile,
Reader reader)
Parses XML.
|
void |
setAdultContent(boolean v) |
void |
setAttribution(String v) |
void |
setContact(String v) |
void |
setDescription(String v) |
void |
setDeveloper(String v) |
void |
setFormat(String v) |
void |
setImage(String v) |
void |
setLongName(String v) |
void |
setSampleSearch(String v) |
void |
setShortName(String v) |
void |
setSyndicationRight(int v) |
void |
setTags(String v) |
void |
setUrl(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, visitChildrenconsumeAttributes, disableStrictValidation, enableStrictValidation, eq, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validateprotected String url
protected String format
url.protected String shortName
protected String longName
protected String description
protected String tags
protected String image
protected String sampleSearch
protected String developer
protected String contact
protected String attribution
protected int syndicationRight
protected boolean adultContent
public OpenSearchDescriptionDocument()
public OpenSearchDescriptionDocument(OpenSearchDescriptionDocument doc)
public final String getUrl()
public void setUrl(String v)
public final String getFormat()
public void setFormat(String v)
public final String getShortName()
public void setShortName(String v)
public final String getLongName()
public void setLongName(String v)
public final String getDescription()
public void setDescription(String v)
public final String getTags()
public void setTags(String v)
public final String getImage()
public void setImage(String v)
public final String getSampleSearch()
public void setSampleSearch(String v)
public final String getDeveloper()
public void setDeveloper(String v)
public final String getContact()
public void setContact(String v)
public final String getAttribution()
public void setAttribution(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 IOException
w - output writerIOExceptionpublic void validateConfiguration()
throws ServiceConfigurationException
url property,
which is dynamically generated based upon the feed that is queried.ServiceConfigurationExceptionpublic void parse(ExtensionProfile extProfile, Reader reader) throws IOException, ParseException
extProfile - extension profilereader - XML input streamIOExceptionParseExceptionCopyright © 2012. All Rights Reserved.