Java Doc for Encode.java in  » Database-ORM » MMBase » org » mmbase » 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 » Database ORM » MMBase » org.mmbase.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.mmbase.util.Encode

Encode
public class Encode (Code)
Class to convert from/to a string (byte[]) from/to a encoded string (byte[]) Supported encodings are at this moment:
  • BASE64
  • HEX
  • ESCAPE_XML
  • ESCAPE_HTML
  • ESCAPE_HTML_ATTRIBUTE
  • ESCAPE_WML
  • ESCAPE_WML_ATTRIBUTE
  • ESCAPE_URL
  • ESCAPE_URL_PARAM
  • ESCAPE_SINGLE_QUOTE
A list of supported encodings can be gotten by java org.mmbase.util.Encode, and you add your own encodings by calling the static function 'register' of this class. Usage:
 Encode encoder = new Encode("ESCAPE_XML");
 System.out.println(  encoder.decode( encoder.encode("& \" < >") )  );
 

author:
   Eduard Witteveen
author:
   Michiel Meeuwissen
version:
   $Id: Encode.java,v 1.28 2007/02/24 21:57:50 nklasens Exp $



Constructor Summary
public  Encode(String encoding)
     Created a encode instance of a certain type of encoding.

Method Summary
public static  Stringdecode(String encoding, String toDecode)
     This function will decode a given string to it's decoded variant.
See Also:   Encode.encode
Parameters:
  encoding - a string that describes which decoding should be used.
Parameters:
  toDecode - a string which is the value which should be encoded.
public  Stringdecode(String toDecode)
     This function will decode a given string to it's decoded variant
Parameters:
  toDecode - a string which is the value which should be encoded.
public static  byte[]decodeBytes(String encoding, String toDecode)
    
public  byte[]decodeBytes(String toDecode)
    
public static  Stringencode(String encoding, String toEncode)
     This function will encode a given string to it's encoded variant.
public static  Stringencode(String encoding, byte[] bytes)
    
public  Stringencode(String toEncode)
     This function will encode a given string to it's encoded variant.
Parameters:
  toEncode - A string which is the value which should be encoded.If the transformer does transform bytes, then first getBytes is done on the String.
public  Stringencode(byte[] bytes)
     Encodes a byte array.
public  StringgetEncoding()
    
public  TransformergetTransformer()
    
public  booleanisByteToCharEncoder()
     Checks if the transformations makes from byte[] String.
public  booleanisCharEncoder()
     Checks if the transformation is between two Strings.
public static  booleanisEncoding(String e)
     Checks if a certain string represents a known transformation.
public static  voidmain(String[] argv)
     Invocation of the class from the commandline for testing.
public static  Set<String>possibleEncodings()
     All the currently known encodings.
public static  voidregister(String clazz)
     Add new transformation types.


Constructor Detail
Encode
public Encode(String encoding)(Code)
Created a encode instance of a certain type of encoding. It will instantiate the right class, and configure it. This instantion will be used when you call 'encode' or 'decode' members later.
Parameters:
  encoding - a string that describes which encoding should be used.




Method Detail
decode
public static String decode(String encoding, String toDecode)(Code)
This function will decode a given string to it's decoded variant.
See Also:   Encode.encode
Parameters:
  encoding - a string that describes which decoding should be used.
Parameters:
  toDecode - a string which is the value which should be encoded. a string which is the encoded representation of toEncodewith the given encoding



decode
public String decode(String toDecode)(Code)
This function will decode a given string to it's decoded variant
Parameters:
  toDecode - a string which is the value which should be encoded. a string which is the encoded representation of toEncodewith the given encoding



decodeBytes
public static byte[] decodeBytes(String encoding, String toDecode)(Code)



decodeBytes
public byte[] decodeBytes(String toDecode)(Code)



encode
public static String encode(String encoding, String toEncode)(Code)
This function will encode a given string to it's encoded variant. It is static, it will make a temporary instance of the Transformer class. If you need to encode alot, it is better to use new Encode first.
Parameters:
  encoding - a string that describes which encoding should be used.
Parameters:
  toEncode - a string which is the value which should be encoded.This can also be a byte[]. a string which is the encoded representation of toEncodewith the given encoding



encode
public static String encode(String encoding, byte[] bytes)(Code)



encode
public String encode(String toEncode)(Code)
This function will encode a given string to it's encoded variant.
Parameters:
  toEncode - A string which is the value which should be encoded.If the transformer does transform bytes, then first getBytes is done on the String. a string which is the encoded representation of toEncodewith the given encoding



encode
public String encode(byte[] bytes)(Code)
Encodes a byte array. a string;;



getEncoding
public String getEncoding()(Code)
Returns the encoding An String representing the coding that is currently used.



getTransformer
public Transformer getTransformer()(Code)

since:
   MMBase-1.8



isByteToCharEncoder
public boolean isByteToCharEncoder()(Code)
Checks if the transformations makes from byte[] String.



isCharEncoder
public boolean isCharEncoder()(Code)
Checks if the transformation is between two Strings.



isEncoding
public static boolean isEncoding(String e)(Code)
Checks if a certain string represents a known transformation.



main
public static void main(String[] argv)(Code)
Invocation of the class from the commandline for testing.



possibleEncodings
public static Set<String> possibleEncodings()(Code)
All the currently known encodings. Set of Strings containing the names of the registered encodings.



register
public static void register(String clazz)(Code)
Add new transformation types. Feed it with a class name (which must implement Transformer)
Parameters:
  clazz - a class name.



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.