| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 15:02:17 PDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>CodecSupport (Apache Shiro 1.2.2 API)</title> |
| <meta name="date" content="2013-05-30"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CodecSupport (Apache Shiro 1.2.2 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CodecSupport.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/codec/H64.html" title="class in org.apache.shiro.codec"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/codec/CodecSupport.html" target="_top">Frames</a></li> |
| <li><a href="CodecSupport.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.codec</div> |
| <h2 title="Class CodecSupport" class="title">Class CodecSupport</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.codec.CodecSupport</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/shiro/crypto/hash/AbstractHash.html" title="class in org.apache.shiro.crypto.hash">AbstractHash</a>, <a href="../../../../org/apache/shiro/authc/credential/SimpleCredentialsMatcher.html" title="class in org.apache.shiro.authc.credential">SimpleCredentialsMatcher</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.30">CodecSupport</a> |
| extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Base abstract class that provides useful encoding and decoding operations, especially for character data.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.9</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING">PREFERRED_ENCODING</a></strong></code> |
| <div class="block">Shiro's default preferred character encoding, equal to <b><code>UTF-8</code></b>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#CodecSupport()">CodecSupport</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#isByteSource(java.lang.Object)">isByteSource</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> |
| <div class="block">Returns <code>true</code> if the specified object can be easily converted to bytes by instances of this class, |
| <code>false</code> otherwise.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#objectToBytes(java.lang.Object)">objectToBytes</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> |
| <div class="block">Default implementation throws a CodecException immediately since it can't infer how to convert the Object |
| to a byte array.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#objectToString(java.lang.Object)">objectToString</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> |
| <div class="block">Default implementation merely returns <code>objectArgument.toString()</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(char[])">toBytes</a></strong>(char[] chars)</code> |
| <div class="block">Converts the specified character array to a byte array using the Shiro's preferred encoding (UTF-8).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(char[], java.lang.String)">toBytes</a></strong>(char[] chars, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</code> |
| <div class="block">Converts the specified character array into a byte array using the specified character encoding.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(java.io.File)">toBytes</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(java.io.InputStream)">toBytes</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)</code> |
| <div class="block">Converts the specified <a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> into a byte array.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(java.lang.Object)">toBytes</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> |
| <div class="block">Converts the specified Object into a byte array.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(java.lang.String)">toBytes</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source)</code> |
| <div class="block">Converts the specified source argument to a byte array with Shiro's |
| <a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(java.lang.String, java.lang.String)">toBytes</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</code> |
| <div class="block">Converts the specified source to a byte array via the specified encoding, throwing a |
| <a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec"><code>CodecException</code></a> if the encoding fails.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static char[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toChars(byte[])">toChars</a></strong>(byte[] bytes)</code> |
| <div class="block">Returns the specified byte array as a character array using the |
| <a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static char[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toChars(byte[], java.lang.String)">toChars</a></strong>(byte[] bytes, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</code> |
| <div class="block">Converts the specified byte array to a character array using the specified character encoding.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toString(byte[])">toString</a></strong>(byte[] bytes)</code> |
| <div class="block">Converts the specified byte array to a String using the <a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toString(byte[], java.lang.String)">toString</a></strong>(byte[] bytes, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding)</code> |
| <div class="block">Converts the specified byte array to a String using the specified character encoding.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toString(java.lang.Object)">toString</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> |
| <div class="block">Converts the specified Object into a String.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="PREFERRED_ENCODING"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PREFERRED_ENCODING</h4> |
| <pre>public static final <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.35">PREFERRED_ENCODING</a></pre> |
| <div class="block">Shiro's default preferred character encoding, equal to <b><code>UTF-8</code></b>.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.shiro.codec.CodecSupport.PREFERRED_ENCODING">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CodecSupport()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CodecSupport</h4> |
| <pre>public <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.30">CodecSupport</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="toBytes(char[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre>public static byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.48">toBytes</a>(char[] chars)</pre> |
| <div class="block">Converts the specified character array to a byte array using the Shiro's preferred encoding (UTF-8). |
| <p/> |
| This is a convenience method equivalent to calling the <a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(java.lang.String, java.lang.String)"><code>toBytes(String,String)</code></a> method with a |
| a wrapping String and <a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>, i.e. |
| <p/> |
| <code>toBytes( new String(chars), <a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a> );</code></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>chars</code> - the character array to be converted to a byte array.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the byte array of the UTF-8 encoded character array.</dd></dl> |
| </li> |
| </ul> |
| <a name="toBytes(char[], java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre>public static byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.65">toBytes</a>(char[] chars, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding) |
| throws <a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></pre> |
| <div class="block">Converts the specified character array into a byte array using the specified character encoding. |
| <p/> |
| This is a convenience method equivalent to calling the <a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(java.lang.String, java.lang.String)"><code>toBytes(String,String)</code></a> method with a |
| a wrapping String and the specified encoding, i.e. |
| <p/> |
| <code>toBytes( new String(chars), encoding );</code></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>chars</code> - the character array to be converted to a byte array</dd><dd><code>encoding</code> - the character encoding to use to when converting to bytes.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the bytes of the specified character array under the specified encoding.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></code> - if the JVM does not support the specified encoding.</dd></dl> |
| </li> |
| </ul> |
| <a name="toBytes(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre>public static byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.77">toBytes</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source)</pre> |
| <div class="block">Converts the specified source argument to a byte array with Shiro's |
| <a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the string to convert to a byte array.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the bytes representing the specified string under the <a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(java.lang.String, java.lang.String)"><code>toBytes(String, String)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="toBytes(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre>public static byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.90">toBytes</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> source, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding) |
| throws <a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></pre> |
| <div class="block">Converts the specified source to a byte array via the specified encoding, throwing a |
| <a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec"><code>CodecException</code></a> if the encoding fails.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the source string to convert to a byte array.</dd><dd><code>encoding</code> - the encoding to use to use.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the byte array of the specified source with the given encoding.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></code> - if the JVM does not support the specified encoding.</dd></dl> |
| </li> |
| </ul> |
| <a name="toString(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.107">toString</a>(byte[] bytes)</pre> |
| <div class="block">Converts the specified byte array to a String using the <a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - the byte array to turn into a String.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the specified byte array as an encoded String (<a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toString(byte[], java.lang.String)"><code>toString(byte[], String)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="toString(byte[], java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.122">toString</a>(byte[] bytes, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding) |
| throws <a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></pre> |
| <div class="block">Converts the specified byte array to a String using the specified character encoding. This implementation |
| does the same thing as <code>new <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true#String(byte[], java.lang.String)" title="class or interface in java.lang"><code>String(byte[], encoding)</code></a></code>, but will |
| wrap any <a href="http://java.sun.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io"><code>UnsupportedEncodingException</code></a> with a nicer runtime <a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec"><code>CodecException</code></a>, allowing you to |
| decide whether or not you want to catch the exception or let it propagate.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - the byte array to convert to a String</dd><dd><code>encoding</code> - the character encoding used to encode the String.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the specified byte array as an encoded String</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></code> - if the JVM does not support the specified encoding.</dd></dl> |
| </li> |
| </ul> |
| <a name="toChars(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toChars</h4> |
| <pre>public static char[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.139">toChars</a>(byte[] bytes)</pre> |
| <div class="block">Returns the specified byte array as a character array using the |
| <a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - the byte array to convert to a char array</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the specified byte array encoded as a character array (<a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toChars(byte[], java.lang.String)"><code>toChars(byte[], String)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="toChars(byte[], java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toChars</h4> |
| <pre>public static char[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.153">toChars</a>(byte[] bytes, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encoding) |
| throws <a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></pre> |
| <div class="block">Converts the specified byte array to a character array using the specified character encoding. |
| <p/> |
| Effectively calls <code><a href="../../../../org/apache/shiro/codec/CodecSupport.html#toString(byte[], java.lang.String)"><code>toString(bytes,encoding)</code></a>.<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true#toCharArray()" title="class or interface in java.lang"><code>toCharArray()</code></a>;</code></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - the byte array to convert to a String</dd><dd><code>encoding</code> - the character encoding used to encode the bytes.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the specified byte array as an encoded char array</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></code> - if the JVM does not support the specified encoding.</dd></dl> |
| </li> |
| </ul> |
| <a name="isByteSource(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isByteSource</h4> |
| <pre>protected boolean <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.177">isByteSource</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> |
| <div class="block">Returns <code>true</code> if the specified object can be easily converted to bytes by instances of this class, |
| <code>false</code> otherwise. |
| <p/> |
| The default implementation returns <code>true</code> IFF the specified object is an instance of one of the following |
| types: |
| <ul> |
| <li><code>byte[]</code></li> |
| <li><code>char[]</code></li> |
| <li><a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util"><code>ByteSource</code></a></li> |
| <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a></li> |
| <li><a href="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a></li> |
| </li><a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a></li> |
| </ul></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - the object to test to see if it can be easily converted to a byte array</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the specified object can be easily converted to bytes by instances of this class, |
| <code>false</code> otherwise.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="toBytes(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre>protected byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.194">toBytes</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> |
| <div class="block">Converts the specified Object into a byte array. |
| <p/> |
| If the argument is a <code>byte[]</code>, <code>char[]</code>, <a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util"><code>ByteSource</code></a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>, <a href="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>, or |
| <a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>, it will be converted automatically and returned.} |
| <p/> |
| If the argument is anything other than these types, it is passed to the |
| <a href="../../../../org/apache/shiro/codec/CodecSupport.html#objectToBytes(java.lang.Object)"><code>objectToBytes</code></a> method which must be overridden by subclasses.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - the Object to convert into a byte array</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a byte array representation of the Object argument.</dd></dl> |
| </li> |
| </ul> |
| <a name="toString(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.228">toString</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> |
| <div class="block">Converts the specified Object into a String. |
| <p/> |
| If the argument is a <code>byte[]</code> or <code>char[]</code> it will be converted to a String using the |
| <a href="../../../../org/apache/shiro/codec/CodecSupport.html#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>. If a String, it will be returned as is. |
| <p/> |
| If the argument is anything other than these three types, it is passed to the |
| <a href="../../../../org/apache/shiro/codec/CodecSupport.html#objectToString(java.lang.Object)"><code>objectToString</code></a> method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - the Object to convert into a byte array</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a byte array representation of the Object argument.</dd></dl> |
| </li> |
| </ul> |
| <a name="toBytes(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre>protected byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.244">toBytes</a>(<a href="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre> |
| </li> |
| </ul> |
| <a name="toBytes(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre>protected byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.265">toBytes</a>(<a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)</pre> |
| <div class="block">Converts the specified <a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> into a byte array.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the InputStream to convert to a byte array</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the bytes of the input stream</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the <code>InputStream</code> argument is <code>null</code>.</dd> |
| <dd><code><a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></code> - if there is any problem reading from the <a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="objectToBytes(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>objectToBytes</h4> |
| <pre>protected byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.300">objectToBytes</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> |
| <div class="block">Default implementation throws a CodecException immediately since it can't infer how to convert the Object |
| to a byte array. This method must be overridden by subclasses if anything other than the three default |
| types (listed in the <a href="../../../../org/apache/shiro/codec/CodecSupport.html#toBytes(java.lang.Object)"><code>toBytes(Object)</code></a> JavaDoc) are to be converted to a byte array.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - the Object to convert to a byte array.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a byte array representation of the Object argument.</dd></dl> |
| </li> |
| </ul> |
| <a name="objectToString(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>objectToString</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.318">objectToString</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> |
| <div class="block">Default implementation merely returns <code>objectArgument.toString()</code>. Subclasses can override this |
| method for different mechanisms of converting an object to a String.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - the Object to convert to a byte array.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a String representation of the Object argument.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CodecSupport.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/shiro/codec/CodecException.html" title="class in org.apache.shiro.codec"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/codec/H64.html" title="class in org.apache.shiro.codec"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/codec/CodecSupport.html" target="_top">Frames</a></li> |
| <li><a href="CodecSupport.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
| |