Google Git
Sign in
apache / juneau-website / 18ad42d5ca1cb4de70d65a31194ec42f473c629f / . / content / site / apidocs-9.0-B1 / org / apache / juneau / serializer / OutputStreamSerializer.html
blob: 0c2f7db0ade97e0a79a047b566d3095ccd79c3c0 [file] [log] [blame]
<!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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OutputStreamSerializer (Apache Juneau 9.0.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OutputStreamSerializer (Apache Juneau 9.0.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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>Prev&nbsp;Class</li>
<li><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.Builder.html" title="class in org.apache.juneau.serializer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/juneau/serializer/OutputStreamSerializer.html" target="_top">Frames</a></li>
<li><a href="OutputStreamSerializer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.juneau.Context">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.juneau.serializer</div>
<h2 title="Class OutputStreamSerializer" class="title">Class OutputStreamSerializer</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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">org.apache.juneau.Context</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/juneau/BeanContextable.html" title="class in org.apache.juneau">org.apache.juneau.BeanContextable</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/juneau/BeanTraverseContext.html" title="class in org.apache.juneau">org.apache.juneau.BeanTraverseContext</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">org.apache.juneau.serializer.Serializer</a></li>
<li>
<ul class="inheritance">
<li>org.apache.juneau.serializer.OutputStreamSerializer</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/juneau/AnnotationProvider.html" title="interface in org.apache.juneau">AnnotationProvider</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/juneau/examples/serializer/ImageSerializer.html" title="class in org.apache.juneau.examples.serializer">ImageSerializer</a>, <a href="../../../../org/apache/juneau/msgpack/MsgPackSerializer.html" title="class in org.apache.juneau.msgpack">MsgPackSerializer</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../src-html/org/apache/juneau/serializer/OutputStreamSerializer.html#line.38">OutputStreamSerializer</a>
extends <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></pre>
<div class="block">Subclass of <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a> for byte-based serializers.
<ul class='notes'>
<li class='note'>This class is thread safe and reusable.
</ul>
<ul class='seealso'>
<li class='link'><a class='doclink' href='../../../../overview-summary.html#juneau-marshall.jm.SerializersAndParsers'>Overview &gt; juneau-marshall &gt; Serializers and Parsers</a>
<li class='extlink'><a class='doclink' target='_blank' href='https://github.com/apache/juneau/blob/master/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/serializer/OutputStreamSerializer.java'>Source</a>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.Builder.html" title="class in org.apache.juneau.serializer">OutputStreamSerializer.Builder</a></span></code>
<div class="block">Builder class.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.juneau.serializer.Serializer">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.juneau.serializer.<a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></h3>
<code><a href="../../../../org/apache/juneau/serializer/Serializer.Null.html" title="class in org.apache.juneau.serializer">Serializer.Null</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.juneau.Context">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.juneau.<a href="../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a></h3>
<code><a href="../../../../org/apache/juneau/Context.html#CONTEXT_APPLY_FILTER">CONTEXT_APPLY_FILTER</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.juneau.AnnotationProvider">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.juneau.<a href="../../../../org/apache/juneau/AnnotationProvider.html" title="interface in org.apache.juneau">AnnotationProvider</a></h3>
<code><a href="../../../../org/apache/juneau/AnnotationProvider.html#DEFAULT">DEFAULT</a>, <a href="../../../../org/apache/juneau/AnnotationProvider.html#DISABLE_ANNOTATION_CACHING">DISABLE_ANNOTATION_CACHING</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.html#OutputStreamSerializer-org.apache.juneau.serializer.OutputStreamSerializer.Builder-">OutputStreamSerializer</a></span>(<a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.Builder.html" title="class in org.apache.juneau.serializer">OutputStreamSerializer.Builder</a>&nbsp;builder)</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.Builder.html" title="class in org.apache.juneau.serializer">OutputStreamSerializer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.html#create--">create</a></span>()</code>
<div class="block">Creates a new builder for this object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializerSession.Builder.html" title="class in org.apache.juneau.serializer">OutputStreamSerializerSession.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.html#createSession--">createSession</a></span>()</code>
<div class="block">Create a session builder based on the properties defined on this context.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/BinaryFormat.html" title="enum in org.apache.juneau">BinaryFormat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.html#getBinaryFormat--">getBinaryFormat</a></span>()</code>
<div class="block">Binary output format.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializerSession.html" title="class in org.apache.juneau.serializer">OutputStreamSerializerSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.html#getSession--">getSession</a></span>()</code>
<div class="block">Returns a session to use for this context.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.html#isWriterSerializer--">isWriterSerializer</a></span>()</code>
<div class="block">Returns <jk>true</jk> if this serializer subclasses from <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html" title="class in org.apache.juneau.serializer"><code>WriterSerializer</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/collections/JsonMap.html" title="class in org.apache.juneau.collections">JsonMap</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.html#properties--">properties</a></span>()</code>
<div class="block">Returns the properties on this bean as a map for debugging.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.html#serialize-java.lang.Object-">serialize</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">Object</a>&nbsp;o)</code>
<div class="block">Convenience method for serializing an object to a <code><jk>byte</jk></code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.serializer.Serializer">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.serializer.<a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></h3>
<code><a href="../../../../org/apache/juneau/serializer/Serializer.html#copy--">copy</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#createSerializerBuilder-java.lang.Class-">createSerializerBuilder</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#doSerialize-org.apache.juneau.serializer.SerializerSession-org.apache.juneau.serializer.SerializerPipe-java.lang.Object-">doSerialize</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#forEachAcceptMediaType-java.util.function.Consumer-">forEachAcceptMediaType</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#getListener--">getListener</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#getMediaTypeRanges--">getMediaTypeRanges</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#getPrimaryMediaType--">getPrimaryMediaType</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#getResponseContentType--">getResponseContentType</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#getResponseHeaders-org.apache.juneau.serializer.SerializerSession-">getResponseHeaders</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#getUriContext--">getUriContext</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#getUriRelativity--">getUriRelativity</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#getUriResolution--">getUriResolution</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#isAddBeanTypes--">isAddBeanTypes</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#isAddRootType--">isAddRootType</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#isKeepNullProperties--">isKeepNullProperties</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#isSortCollections--">isSortCollections</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#isSortMaps--">isSortMaps</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#isTrimEmptyCollections--">isTrimEmptyCollections</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#isTrimEmptyMaps--">isTrimEmptyMaps</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#isTrimStrings--">isTrimStrings</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#serialize-java.lang.Object-java.lang.Object-">serialize</a>, <a href="../../../../org/apache/juneau/serializer/Serializer.html#serializeToString-java.lang.Object-">serializeToString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.BeanTraverseContext">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.<a href="../../../../org/apache/juneau/BeanTraverseContext.html" title="class in org.apache.juneau">BeanTraverseContext</a></h3>
<code><a href="../../../../org/apache/juneau/BeanTraverseContext.html#getInitialDepth--">getInitialDepth</a>, <a href="../../../../org/apache/juneau/BeanTraverseContext.html#getMaxDepth--">getMaxDepth</a>, <a href="../../../../org/apache/juneau/BeanTraverseContext.html#isDetectRecursions--">isDetectRecursions</a>, <a href="../../../../org/apache/juneau/BeanTraverseContext.html#isIgnoreRecursions--">isIgnoreRecursions</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.BeanContextable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.<a href="../../../../org/apache/juneau/BeanContextable.html" title="class in org.apache.juneau">BeanContextable</a></h3>
<code><a href="../../../../org/apache/juneau/BeanContextable.html#getBeanContext--">getBeanContext</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.Context">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.<a href="../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a></h3>
<code><a href="../../../../org/apache/juneau/Context.html#createBuilder-java.lang.Class-">createBuilder</a>, <a href="../../../../org/apache/juneau/Context.html#firstAnnotation-java.lang.Class-java.lang.Class-java.util.function.Predicate-">firstAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#firstAnnotation-java.lang.Class-java.lang.reflect.Constructor-java.util.function.Predicate-">firstAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#firstAnnotation-java.lang.Class-java.lang.reflect.Field-java.util.function.Predicate-">firstAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#firstAnnotation-java.lang.Class-java.lang.reflect.Method-java.util.function.Predicate-">firstAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#firstDeclaredAnnotation-java.lang.Class-java.lang.Class-java.util.function.Predicate-">firstDeclaredAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#forEachAnnotation-java.lang.Class-java.lang.Class-java.util.function.Predicate-java.util.function.Consumer-">forEachAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#forEachAnnotation-java.lang.Class-java.lang.reflect.Constructor-java.util.function.Predicate-java.util.function.Consumer-">forEachAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#forEachAnnotation-java.lang.Class-java.lang.reflect.Field-java.util.function.Predicate-java.util.function.Consumer-">forEachAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#forEachAnnotation-java.lang.Class-java.lang.reflect.Method-java.util.function.Predicate-java.util.function.Consumer-">forEachAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#forEachDeclaredAnnotation-java.lang.Class-java.lang.Class-java.util.function.Predicate-java.util.function.Consumer-">forEachDeclaredAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#hasAnnotation-java.lang.Class-java.lang.Class-">hasAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#hasAnnotation-java.lang.Class-java.lang.reflect.Constructor-">hasAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#hasAnnotation-java.lang.Class-java.lang.reflect.Field-">hasAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#hasAnnotation-java.lang.Class-java.lang.reflect.Method-">hasAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#isDebug--">isDebug</a>, <a href="../../../../org/apache/juneau/Context.html#lastAnnotation-java.lang.Class-java.lang.Class-java.util.function.Predicate-">lastAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#lastAnnotation-java.lang.Class-java.lang.reflect.Constructor-java.util.function.Predicate-">lastAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#lastAnnotation-java.lang.Class-java.lang.reflect.Field-java.util.function.Predicate-">lastAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#lastAnnotation-java.lang.Class-java.lang.reflect.Method-java.util.function.Predicate-">lastAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#lastDeclaredAnnotation-java.lang.Class-java.lang.Class-java.util.function.Predicate-">lastDeclaredAnnotation</a>, <a href="../../../../org/apache/juneau/Context.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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">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">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">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">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">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">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">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">notifyAll</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">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">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">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="OutputStreamSerializer-org.apache.juneau.serializer.OutputStreamSerializer.Builder-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OutputStreamSerializer</h4>
<pre>protected&nbsp;<a href="../../../../src-html/org/apache/juneau/serializer/OutputStreamSerializer.html#line.747">OutputStreamSerializer</a>(<a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.Builder.html" title="class in org.apache.juneau.serializer">OutputStreamSerializer.Builder</a>&nbsp;builder)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - The builder for this object.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="create--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.Builder.html" title="class in org.apache.juneau.serializer">OutputStreamSerializer.Builder</a>&nbsp;<a href="../../../../src-html/org/apache/juneau/serializer/OutputStreamSerializer.html#line.49">create</a>()</pre>
<div class="block">Creates a new builder for this object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new builder.</dd>
</dl>
</li>
</ul>
<a name="createSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSession</h4>
<pre>public&nbsp;<a href="../../../../org/apache/juneau/serializer/OutputStreamSerializerSession.Builder.html" title="class in org.apache.juneau.serializer">OutputStreamSerializerSession.Builder</a>&nbsp;<a href="../../../../src-html/org/apache/juneau/serializer/OutputStreamSerializer.html#line.754">createSession</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/juneau/Context.html#createSession--">Context</a></code></span></div>
<div class="block">Create a session builder based on the properties defined on this context.
<p>
Use this method for creating sessions where you want to override basic settings.
Otherwise, use <a href="../../../../org/apache/juneau/Context.html#getSession--"><code>Context.getSession()</code></a> directly.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/juneau/serializer/Serializer.html#createSession--">createSession</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new session builder.</dd>
</dl>
</li>
</ul>
<a name="getSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre>public&nbsp;<a href="../../../../org/apache/juneau/serializer/OutputStreamSerializerSession.html" title="class in org.apache.juneau.serializer">OutputStreamSerializerSession</a>&nbsp;<a href="../../../../src-html/org/apache/juneau/serializer/OutputStreamSerializer.html#line.759">getSession</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/juneau/Context.html#getSession--">Context</a></code></span></div>
<div class="block">Returns a session to use for this context.
<p>
Note that subclasses may opt to return a reusable non-modifiable session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/juneau/serializer/Serializer.html#getSession--">getSession</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new session object.</dd>
</dl>
</li>
</ul>
<a name="isWriterSerializer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWriterSerializer</h4>
<pre>public final&nbsp;boolean&nbsp;<a href="../../../../src-html/org/apache/juneau/serializer/OutputStreamSerializer.html#line.764">isWriterSerializer</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/juneau/serializer/Serializer.html#isWriterSerializer--">Serializer</a></code></span></div>
<div class="block">Returns <jk>true</jk> if this serializer subclasses from <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html" title="class in org.apache.juneau.serializer"><code>WriterSerializer</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/juneau/serializer/Serializer.html#isWriterSerializer--">isWriterSerializer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><jk>true</jk> if this serializer subclasses from <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html" title="class in org.apache.juneau.serializer"><code>WriterSerializer</code></a>.</dd>
</dl>
</li>
</ul>
<a name="serialize-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public final&nbsp;byte[]&nbsp;<a href="../../../../src-html/org/apache/juneau/serializer/OutputStreamSerializer.html#line.776">serialize</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">Object</a>&nbsp;o)
throws <a href="../../../../org/apache/juneau/serializer/SerializeException.html" title="class in org.apache.juneau.serializer">SerializeException</a></pre>
<div class="block">Convenience method for serializing an object to a <code><jk>byte</jk></code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/juneau/serializer/Serializer.html#serialize-java.lang.Object-">serialize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>o</code> - The object to serialize.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The output serialized to a byte array.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/juneau/serializer/SerializeException.html" title="class in org.apache.juneau.serializer">SerializeException</a></code> - If a problem occurred trying to convert the output.</dd>
</dl>
</li>
</ul>
<a name="getBinaryFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBinaryFormat</h4>
<pre>protected final&nbsp;<a href="../../../../org/apache/juneau/BinaryFormat.html" title="enum in org.apache.juneau">BinaryFormat</a>&nbsp;<a href="../../../../src-html/org/apache/juneau/serializer/OutputStreamSerializer.html#line.791">getBinaryFormat</a>()</pre>
<div class="block">Binary output format.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The format to use for the <a href="../../../../org/apache/juneau/serializer/Serializer.html#serializeToString-java.lang.Object-"><code>Serializer.serializeToString(Object)</code></a> method on stream-based serializers when converting byte arrays to strings.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.Builder.html#binaryFormat-org.apache.juneau.BinaryFormat-"><code>OutputStreamSerializer.Builder.binaryFormat(BinaryFormat)</code></a></dd>
</dl>
</li>
</ul>
<a name="properties--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>properties</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/juneau/collections/JsonMap.html" title="class in org.apache.juneau.collections">JsonMap</a>&nbsp;<a href="../../../../src-html/org/apache/juneau/serializer/OutputStreamSerializer.html#line.800">properties</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/juneau/Context.html#properties--">Context</a></code></span></div>
<div class="block">Returns the properties on this bean as a map for debugging.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/juneau/serializer/Serializer.html#properties--">properties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The properties on this bean as a map for debugging.</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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>Prev&nbsp;Class</li>
<li><a href="../../../../org/apache/juneau/serializer/OutputStreamSerializer.Builder.html" title="class in org.apache.juneau.serializer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/juneau/serializer/OutputStreamSerializer.html" target="_top">Frames</a></li>
<li><a href="OutputStreamSerializer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.juneau.Context">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2016&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>