Java Doc for WrapperRepresentation.java in  » Web-Services » restlet-1.0.8 » org » restlet » util » 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 » Web Services » restlet 1.0.8 » org.restlet.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.restlet.resource.Representation
   org.restlet.util.WrapperRepresentation

All known Subclasses:   com.noelios.restlet.application.DecodeRepresentation,  com.noelios.restlet.application.EncodeRepresentation,
WrapperRepresentation
public class WrapperRepresentation extends Representation (Code)
Representation wrapper. Useful for application developer who need to enrich the representation with application related properties and behavior.
See Also:    The decorator (aka * wrapper) pattern
author:
   Jerome Louvel (contact@noelios.com)



Constructor Summary
public  WrapperRepresentation(Representation wrappedRepresentation)
     Constructor.

Method Summary
public  ReadableByteChannelgetChannel()
     Returns a channel with the representation's content.
If it is supported by a file, a read-only instance of FileChannel is returned.
This method is ensured to return a fresh channel for each invocation unless it is a transient representation, in which case null is returned.
public  CharacterSetgetCharacterSet()
     Returns the character set or null if not applicable.
public  List<Encoding>getEncodings()
     Returns the list of encodings.
public  DategetExpirationDate()
     Returns the future date when this representation expire.
public  ReferencegetIdentifier()
     Returns the official identifier.
public  List<Language>getLanguages()
     Returns the list of languages.
public  MediaTypegetMediaType()
     Returns the media type.
public  DategetModificationDate()
     Returns the last date when this representation was modified.
public  longgetSize()
     Returns the size in bytes if known, UNKNOWN_SIZE (-1) otherwise.
public  InputStreamgetStream()
     Returns a stream with the representation's content.
public  TaggetTag()
     Returns the tag.
public  StringgetText()
     Converts the representation to a string value.
public  RepresentationgetWrappedRepresentation()
     Returns the wrapped representation.
public  booleanisAvailable()
     Indicates if some fresh content is available, without having to actually call one of the content manipulation method like getStream() that would actually consume it.
public  booleanisTransient()
     Indicates if the representation's content is transient, which means that it can be obtained only once.
public  voidsetAvailable(boolean isAvailable)
     Indicates if some fresh content is available.
public  voidsetCharacterSet(CharacterSet characterSet)
     Sets the character set or null if not applicable.
public  voidsetExpirationDate(Date expirationDate)
     Sets the future date when this representation expire.
public  voidsetIdentifier(Reference identifier)
     Sets the official identifier.
public  voidsetIdentifier(String identifierUri)
     Sets the official identifier from a URI string.
public  voidsetMediaType(MediaType mediaType)
     Sets the media type.
public  voidsetModificationDate(Date modificationDate)
     Sets the last date when this representation was modified.
public  voidsetSize(long expectedSize)
     Sets the expected size in bytes if known, -1 otherwise.
public  voidsetTag(Tag tag)
     Sets the tag.
public  voidsetTransient(boolean isTransient)
     Indicates if the representation's content is transient.
public  voidwrite(OutputStream outputStream)
     Writes the representation to a byte stream.
public  voidwrite(WritableByteChannel writableChannel)
     Writes the representation to a byte channel.


Constructor Detail
WrapperRepresentation
public WrapperRepresentation(Representation wrappedRepresentation)(Code)
Constructor.
Parameters:
  wrappedRepresentation - The wrapped representation.




Method Detail
getChannel
public ReadableByteChannel getChannel() throws IOException(Code)
Returns a channel with the representation's content.
If it is supported by a file, a read-only instance of FileChannel is returned.
This method is ensured to return a fresh channel for each invocation unless it is a transient representation, in which case null is returned. A channel with the representation's content.
throws:
  IOException -



getCharacterSet
public CharacterSet getCharacterSet()(Code)
Returns the character set or null if not applicable. The character set or null if not applicable.



getEncodings
public List<Encoding> getEncodings()(Code)
Returns the list of encodings. The list of encodings.



getExpirationDate
public Date getExpirationDate()(Code)
Returns the future date when this representation expire. If this information is not known, returns null. The expiration date.



getIdentifier
public Reference getIdentifier()(Code)
Returns the official identifier. The official identifier.



getLanguages
public List<Language> getLanguages()(Code)
Returns the list of languages. The list of languages.



getMediaType
public MediaType getMediaType()(Code)
Returns the media type. The media type.



getModificationDate
public Date getModificationDate()(Code)
Returns the last date when this representation was modified. If this information is not known, returns null. The modification date.



getSize
public long getSize()(Code)
Returns the size in bytes if known, UNKNOWN_SIZE (-1) otherwise. The size in bytes if known, UNKNOWN_SIZE (-1) otherwise.



getStream
public InputStream getStream() throws IOException(Code)
Returns a stream with the representation's content. This method is ensured to return a fresh stream for each invocation unless it is a transient representation, in which case null is returned. A stream with the representation's content.
throws:
  IOException -



getTag
public Tag getTag()(Code)
Returns the tag. The tag.



getText
public String getText() throws IOException(Code)
Converts the representation to a string value. Be careful when using this method as the conversion of large content to a string fully stored in memory can result in OutOfMemoryErrors being thrown. The representation as a string value.



getWrappedRepresentation
public Representation getWrappedRepresentation()(Code)
Returns the wrapped representation. The wrapped representation.



isAvailable
public boolean isAvailable()(Code)
Indicates if some fresh content is available, without having to actually call one of the content manipulation method like getStream() that would actually consume it. This is especially useful for transient representation whose content can only be accessed once. True if some fresh content is available.



isTransient
public boolean isTransient()(Code)
Indicates if the representation's content is transient, which means that it can be obtained only once. This is often the case with representations transmitted via network sockets for example. In such case, if you need to read the content several times, you need to cache it first, for example into memory or into a file. True if the representation's content is transient.



setAvailable
public void setAvailable(boolean isAvailable)(Code)
Indicates if some fresh content is available.
Parameters:
  isAvailable - True if some fresh content is available.



setCharacterSet
public void setCharacterSet(CharacterSet characterSet)(Code)
Sets the character set or null if not applicable.
Parameters:
  characterSet - The character set or null if not applicable.



setExpirationDate
public void setExpirationDate(Date expirationDate)(Code)
Sets the future date when this representation expire. If this information is not known, pass null.
Parameters:
  expirationDate - The expiration date.



setIdentifier
public void setIdentifier(Reference identifier)(Code)
Sets the official identifier.
Parameters:
  identifier - The official identifier.



setIdentifier
public void setIdentifier(String identifierUri)(Code)
Sets the official identifier from a URI string.
Parameters:
  identifierUri - The official identifier to parse.



setMediaType
public void setMediaType(MediaType mediaType)(Code)
Sets the media type.
Parameters:
  mediaType - The media type.



setModificationDate
public void setModificationDate(Date modificationDate)(Code)
Sets the last date when this representation was modified. If this information is not known, pass null.
Parameters:
  modificationDate - The modification date.



setSize
public void setSize(long expectedSize)(Code)
Sets the expected size in bytes if known, -1 otherwise.
Parameters:
  expectedSize - The expected size in bytes if known, -1 otherwise.



setTag
public void setTag(Tag tag)(Code)
Sets the tag.
Parameters:
  tag - The tag.



setTransient
public void setTransient(boolean isTransient)(Code)
Indicates if the representation's content is transient.
Parameters:
  isTransient - True if the representation's content is transient.



write
public void write(OutputStream outputStream) throws IOException(Code)
Writes the representation to a byte stream. This method is ensured to write the full content for each invocation unless it is a transient representation, in which case an exception is thrown.
Parameters:
  outputStream - The output stream.
throws:
  IOException -



write
public void write(WritableByteChannel writableChannel) throws IOException(Code)
Writes the representation to a byte channel. This method is ensured to write the full content for each invocation unless it is a transient representation, in which case an exception is thrown.
Parameters:
  writableChannel - A writable byte channel.
throws:
  IOException -



Methods inherited from org.restlet.resource.Representation
abstract public ReadableByteChannel getChannel() throws IOException(Code)(Java Doc)
abstract public InputStream getStream() throws IOException(Code)(Java Doc)
public String getText() throws IOException(Code)(Java Doc)
public boolean isAvailable()(Code)(Java Doc)
public boolean isTransient()(Code)(Java Doc)
public void setAvailable(boolean available)(Code)(Java Doc)
public void setTransient(boolean isTransient)(Code)(Java Doc)
abstract public void write(OutputStream outputStream) throws IOException(Code)(Java Doc)
abstract public void write(WritableByteChannel writableChannel) throws IOException(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.