Java Doc for WireFeedInput.java in  » RSS-RDF » Rome » com » sun » syndication » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » RSS RDF » Rome » com.sun.syndication.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.syndication.io.WireFeedInput

WireFeedInput
public class WireFeedInput (Code)
Parses an XML document (File, InputStream, Reader, W3C SAX InputSource, W3C DOM Document or JDom DOcument) into an WireFeed (RSS/Atom).

It accepts all flavors of RSS (0.90, 0.91, 0.92, 0.93, 0.94, 1.0 and 2.0) and Atom 0.3 feeds. Parsers are plugable (they must implement the WireFeedParser interface).

The WireFeedInput useds liberal parsers.


author:
   Alejandro Abdelnur




Constructor Summary
public  WireFeedInput()
     Creates a WireFeedInput instance with input validation turned off.
public  WireFeedInput(boolean validate)
     Creates a WireFeedInput instance.


Parameters:
  validate - indicates if the input should be validated.


Method Summary
public  WireFeedbuild(File file)
     Builds an WireFeed (RSS or Atom) from a file.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.


Parameters:
  file - file to read to create the WireFeed.

public  WireFeedbuild(Reader reader)
     Builds an WireFeed (RSS or Atom) from an Reader.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.


Parameters:
  reader - Reader to read to create the WireFeed.

public  WireFeedbuild(InputSource is)
     Builds an WireFeed (RSS or Atom) from an W3C SAX InputSource.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.


Parameters:
  is - W3C SAX InputSource to read to create the WireFeed.

public  WireFeedbuild(org.w3c.dom.Document document)
     Builds an WireFeed (RSS or Atom) from an W3C DOM document.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.


Parameters:
  document - W3C DOM document to read to create the WireFeed.

public  WireFeedbuild(Document document)
     Builds an WireFeed (RSS or Atom) from an JDOM document.

NOTE: All other build methods delegate to this method.


Parameters:
  document - JDOM document to read to create the WireFeed.

protected  SAXBuildercreateSAXBuilder()
     Creates and sets up a org.jdom.input.SAXBuilder for parsing.
public static  ListgetSupportedFeedTypes()
     Returns the list of supported input feed types.
public  booleangetXmlHealerOn()
     Indicates if the WiredFeedInput instance will XML heal (if necessary) the character stream.
public  voidsetXmlHealerOn(boolean heals)
     Enables XML healing in the WiredFeedInput instance.


Constructor Detail
WireFeedInput
public WireFeedInput()(Code)
Creates a WireFeedInput instance with input validation turned off.




WireFeedInput
public WireFeedInput(boolean validate)(Code)
Creates a WireFeedInput instance.


Parameters:
  validate - indicates if the input should be validated. NOT IMPLEMENTED YET (validation does not happen)





Method Detail
build
public WireFeed build(File file) throws FileNotFoundException, IOException, IllegalArgumentException, FeedException(Code)
Builds an WireFeed (RSS or Atom) from a file.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.


Parameters:
  file - file to read to create the WireFeed. the WireFeed read from the file.
throws:
  FileNotFoundException - thrown if the file could not be found.
throws:
  IOException - thrown if there is problem reading the file.
throws:
  IllegalArgumentException - thrown if feed type could not be understood by any of the underlying parsers.
throws:
  FeedException - if the feed could not be parsed




build
public WireFeed build(Reader reader) throws IllegalArgumentException, FeedException(Code)
Builds an WireFeed (RSS or Atom) from an Reader.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.


Parameters:
  reader - Reader to read to create the WireFeed. the WireFeed read from the Reader.
throws:
  IllegalArgumentException - thrown if feed type could not be understood by any of the underlying parsers.
throws:
  FeedException - if the feed could not be parsed




build
public WireFeed build(InputSource is) throws IllegalArgumentException, FeedException(Code)
Builds an WireFeed (RSS or Atom) from an W3C SAX InputSource.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.


Parameters:
  is - W3C SAX InputSource to read to create the WireFeed. the WireFeed read from the W3C SAX InputSource.
throws:
  IllegalArgumentException - thrown if feed type could not be understood by any of the underlying parsers.
throws:
  FeedException - if the feed could not be parsed




build
public WireFeed build(org.w3c.dom.Document document) throws IllegalArgumentException, FeedException(Code)
Builds an WireFeed (RSS or Atom) from an W3C DOM document.

NOTE: This method delages to the 'AsbtractFeed WireFeedInput#build(org.jdom.Document)'.


Parameters:
  document - W3C DOM document to read to create the WireFeed. the WireFeed read from the W3C DOM document.
throws:
  IllegalArgumentException - thrown if feed type could not be understood by any of the underlying parsers.
throws:
  FeedException - if the feed could not be parsed




build
public WireFeed build(Document document) throws IllegalArgumentException, FeedException(Code)
Builds an WireFeed (RSS or Atom) from an JDOM document.

NOTE: All other build methods delegate to this method.


Parameters:
  document - JDOM document to read to create the WireFeed. the WireFeed read from the JDOM document.
throws:
  IllegalArgumentException - thrown if feed type could not be understood by any of the underlying parsers.
throws:
  FeedException - if the feed could not be parsed




createSAXBuilder
protected SAXBuilder createSAXBuilder()(Code)
Creates and sets up a org.jdom.input.SAXBuilder for parsing. a new org.jdom.input.SAXBuilder object



getSupportedFeedTypes
public static List getSupportedFeedTypes()(Code)
Returns the list of supported input feed types.


See Also:   WireFeed
See Also:    for details on the format of these strings.
See Also:   

a list of String elements with the supported input feed types.




getXmlHealerOn
public boolean getXmlHealerOn()(Code)
Indicates if the WiredFeedInput instance will XML heal (if necessary) the character stream.

Healing trims leading chars from the stream (empty spaces and comments) until the XML prolog.

Healing resolves HTML entities (from literal to code number) in the reader.

The healing is done only with the build(File) and build(Reader) signatures.

By default is TRUE.

TRUE if healing is enabled, FALSE if not.




setXmlHealerOn
public void setXmlHealerOn(boolean heals)(Code)
Enables XML healing in the WiredFeedInput instance.

Healing trims leading chars from the stream (empty spaces and comments) until the XML prolog.

Healing resolves HTML entities (from literal to code number) in the reader.

The healing is done only with the build(File) and build(Reader) signatures.

By default is TRUE.


Parameters:
  heals - TRUE enables stream healing, FALSE disables it.




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.