| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>CodecSupport (Apache Shiro :: Lang 1.10.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CodecSupport (Apache Shiro :: Lang 1.10.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code --> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.shiro.codec</a></div> |
| <h2 title="Class CodecSupport" class="title">Class CodecSupport</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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"> |
| <hr> |
| <pre>public abstract class <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.30">CodecSupport</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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="simpleTagLabel">Since:</span></dt> |
| <dd>0.9</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PREFERRED_ENCODING">PREFERRED_ENCODING</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Shiro's default preferred character encoding, equal to <b><code>UTF-8</code></b>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">CodecSupport</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isByteSource(java.lang.Object)">isByteSource</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> o)</code></th> |
| <td class="colLast"> |
| <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 id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#objectToBytes(java.lang.Object)">objectToBytes</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> o)</code></th> |
| <td class="colLast"> |
| <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 id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#objectToString(java.lang.Object)">objectToString</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> o)</code></th> |
| <td class="colLast"> |
| <div class="block">Default implementation merely returns <code>objectArgument.toString()</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBytes(char%5B%5D)">toBytes</a></span>​(char[] chars)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the specified character array to a byte array using the Shiro's preferred encoding (UTF-8).</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBytes(char%5B%5D,java.lang.String)">toBytes</a></span>​(char[] chars, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the specified character array into a byte array using the specified character encoding.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBytes(java.io.File)">toBytes</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> file)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBytes(java.io.InputStream)">toBytes</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> in)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the specified <a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>InputStream</code></a> into a byte array.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBytes(java.lang.Object)">toBytes</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> o)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the specified Object into a byte array.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBytes(java.lang.String)">toBytes</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the specified source argument to a byte array with Shiro's |
| <a href="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBytes(java.lang.String,java.lang.String)">toBytes</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the specified source to a byte array via the specified encoding, throwing a |
| <a href="CodecException.html" title="class in org.apache.shiro.codec"><code>CodecException</code></a> if the encoding fails.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static char[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toChars(byte%5B%5D)">toChars</a></span>​(byte[] bytes)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the specified byte array as a character array using the |
| <a href="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static char[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toChars(byte%5B%5D,java.lang.String)">toChars</a></span>​(byte[] bytes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the specified byte array to a character array using the specified character encoding.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString(byte%5B%5D)">toString</a></span>​(byte[] bytes)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the specified byte array to a String using the <a href="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString(byte%5B%5D,java.lang.String)">toString</a></span>​(byte[] bytes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the specified byte array to a String using the specified character encoding.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString(java.lang.Object)">toString</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> o)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the specified Object into a String.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="PREFERRED_ENCODING"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PREFERRED_ENCODING</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">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="seeLabel">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> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </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> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="toBytes(char[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre class="methodSignature">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="#toBytes(java.lang.String,java.lang.String)"><code>toBytes(String,String)</code></a> method with a |
| a wrapping String and <a href="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>, i.e. |
| <p/> |
| <code>toBytes( new String(chars), <a href="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a> );</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>chars</code> - the character array to be converted to a byte array.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the byte array of the UTF-8 encoded character array.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toBytes(char[],java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre class="methodSignature">public static byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.65">toBytes</a>​(char[] chars, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding) |
| throws <a href="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="#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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the bytes of the specified character array under the specified encoding.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="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 id="toBytes(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre class="methodSignature">public static byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.77">toBytes</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source)</pre> |
| <div class="block">Converts the specified source argument to a byte array with Shiro's |
| <a href="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - the string to convert to a byte array.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the bytes representing the specified string under the <a href="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#toBytes(java.lang.String,java.lang.String)"><code>toBytes(String, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toBytes(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre class="methodSignature">public static byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.90">toBytes</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> source, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding) |
| throws <a href="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="CodecException.html" title="class in org.apache.shiro.codec"><code>CodecException</code></a> if the encoding fails.</div> |
| <dl> |
| <dt><span class="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the byte array of the specified source with the given encoding.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="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 id="toString(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">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="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bytes</code> - the byte array to turn into a String.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the specified byte array as an encoded String (<a href="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#toString(byte%5B%5D,java.lang.String)"><code>toString(byte[], String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString(byte[],java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.122">toString</a>​(byte[] bytes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding) |
| throws <a href="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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true#%3Cinit%3E(byte%5B%5D,java.lang.String)" title="class or interface in java.lang" class="externalLink"><code>String(byte[], encoding)</code></a></code>, but will |
| wrap any <a href="https://docs.oracle.com/javase/8/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>UnsupportedEncodingException</code></a> with a nicer runtime <a href="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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the specified byte array as an encoded String</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="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 id="toChars(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toChars</h4> |
| <pre class="methodSignature">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="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bytes</code> - the byte array to convert to a char array</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the specified byte array encoded as a character array (<a href="#PREFERRED_ENCODING"><code>PREFERRED_ENCODING</code></a>).</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#toChars(byte%5B%5D,java.lang.String)"><code>toChars(byte[], String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toChars(byte[],java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toChars</h4> |
| <pre class="methodSignature">public static char[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.153">toChars</a>​(byte[] bytes, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> encoding) |
| throws <a href="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="#toString(byte%5B%5D,java.lang.String)"><code>toString(bytes,encoding)</code></a>.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true#toCharArray()" title="class or interface in java.lang" class="externalLink"><code>toCharArray()</code></a>;</code></div> |
| <dl> |
| <dt><span class="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>the specified byte array as an encoded char array</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="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 id="isByteSource(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isByteSource</h4> |
| <pre class="methodSignature">protected boolean <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.177">isByteSource</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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="../util/ByteSource.html" title="interface in org.apache.shiro.util"><code>ByteSource</code></a></li> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a></li> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>File</code></a></li> |
| </li><a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>InputStream</code></a></li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">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="returnLabel">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="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toBytes(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre class="methodSignature">protected byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.194">toBytes</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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="../util/ByteSource.html" title="interface in org.apache.shiro.util"><code>ByteSource</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>File</code></a>, or |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><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="#objectToBytes(java.lang.Object)"><code>objectToBytes</code></a> method which must be overridden by subclasses.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - the Object to convert into a byte array</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a byte array representation of the Object argument.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.228">toString</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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="#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="#objectToString(java.lang.Object)"><code>objectToString</code></a> method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - the Object to convert into a byte array</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a byte array representation of the Object argument.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toBytes(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre class="methodSignature">protected byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.244">toBytes</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> file)</pre> |
| </li> |
| </ul> |
| <a id="toBytes(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBytes</h4> |
| <pre class="methodSignature">protected byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.265">toBytes</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a> in)</pre> |
| <div class="block">Converts the specified <a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>InputStream</code></a> into a byte array.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>in</code> - the InputStream to convert to a byte array</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the bytes of the input stream</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the <code>InputStream</code> argument is <code>null</code>.</dd> |
| <dd><code><a href="CodecException.html" title="class in org.apache.shiro.codec">CodecException</a></code> - if there is any problem reading from the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>InputStream</code></a>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="objectToBytes(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>objectToBytes</h4> |
| <pre class="methodSignature">protected byte[] <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.300">objectToBytes</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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="#toBytes(java.lang.Object)"><code>toBytes(Object)</code></a> JavaDoc) are to be converted to a byte array.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - the Object to convert to a byte array.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a byte array representation of the Object argument.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="objectToString(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>objectToString</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../src-html/org/apache/shiro/codec/CodecSupport.html#line.318">objectToString</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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="paramLabel">Parameters:</span></dt> |
| <dd><code>o</code> - the Object to convert to a byte array.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String representation of the Object argument.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |