| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <link rel="canonical" href="https://ignite.apache.org/releases/2.6.0/javadoc/org/apache/ignite/IgniteBinary.html" /> |
| <META NAME="ROBOTS" CONTENT="NOINDEX"> |
| |
| <!-- Generated by javadoc (1.8.0_77) on Tue Jul 10 11:04:38 UTC 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IgniteBinary (Ignite 2.6.0)</title> |
| <meta name="date" content="2018-07-10"> |
| <link rel="stylesheet" type="text/css" href="../../../javadoc.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-61232409-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script></head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IgniteBinary (Ignite 2.6.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/IgniteBinary.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 class="aboutLanguage">Ignite - In-Memory Data Fabric</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/apache/ignite/IgniteAuthenticationException.html" title="class in org.apache.ignite"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/ignite/IgniteBinary.html" target="_top">Frames</a></li> |
| <li><a href="IgniteBinary.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.ignite</div> |
| <h2 title="Interface IgniteBinary" class="title">Interface IgniteBinary</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">IgniteBinary</span></pre> |
| <div class="block">Defines binary objects functionality. With binary objects you are able to: |
| <ul> |
| <li>Seamlessly interoperate between Java, .NET, and C++.</li> |
| <li>Make any object binary with zero code change to your existing code.</li> |
| <li>Nest binary objects within each other.</li> |
| <li>Automatically handle <code>circular</code> or <code>null</code> references.</li> |
| <li>Automatically convert collections and maps between Java, .NET, and C++.</li> |
| <li> |
| Optionally avoid deserialization of objects on the server side |
| (objects are stored in <a href="../../../org/apache/ignite/binary/BinaryObject.html" title="interface in org.apache.ignite.binary"><code>BinaryObject</code></a> format). |
| </li> |
| <li>Avoid need to have concrete class definitions on the server side.</li> |
| <li>Dynamically change structure of the classes without having to restart the cluster.</li> |
| <li>Index into binary objects for querying purposes.</li> |
| </ul> |
| <h1 class="header">Working With Binaries Directly</h1> |
| Once an object is defined as binary, |
| Ignite will always store it in memory in the binary (i.e. binary) format. |
| User can choose to work either with the binary format or with the deserialized form |
| (assuming that class definitions are present in the classpath). |
| <p> |
| To work with the binary format directly, user should create a special cache projection |
| using IgniteCache.withKeepBinary() method and then retrieve individual fields as needed: |
| <pre name=code class=java> |
| IgniteCache<BinaryObject, BinaryObject> prj = cache.withKeepBinary(); |
| |
| // Convert instance of MyKey to binary format. |
| // We could also use BinaryBuilder to create the key in binary format directly. |
| BinaryObject key = grid.binary().toBinary(new MyKey()); |
| |
| BinaryObject val = prj.get(key); |
| |
| String field = val.field("myFieldName"); |
| </pre> |
| Alternatively, if we have class definitions in the classpath, we may choose to work with deserialized |
| typed objects at all times. |
| <pre name=code class=java> |
| IgniteCache<MyKey.class, MyValue.class> cache = grid.cache(null); |
| |
| MyValue val = cache.get(new MyKey()); |
| |
| // Normal java getter. |
| String fieldVal = val.getMyFieldName(); |
| </pre> |
| If we used, for example, one of the automatically handled binary types for a key, like integer, |
| and still wanted to work with binary binary format for values, then we would declare cache projection |
| as follows: |
| <pre name=code class=java> |
| IgniteCache<Integer.class, BinaryObject> prj = cache.withKeepBinary(); |
| </pre> |
| <h1 class="header">Automatic Binary Types</h1> |
| Note that only binary classes are converted to <a href="../../../org/apache/ignite/binary/BinaryObject.html" title="interface in org.apache.ignite.binary"><code>BinaryObject</code></a> format. Following |
| classes are never converted (e.g., <a href="../../../org/apache/ignite/IgniteBinary.html#toBinary-java.lang.Object-"><code>toBinary(Object)</code></a> method will return original |
| object, and instances of these classes will be stored in cache without changes): |
| <ul> |
| <li>All primitives (byte, int, ...) and there boxed versions (Byte, Integer, ...)</li> |
| <li>Arrays of primitives (byte[], int[], ...)</li> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> and array of <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>s</li> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util"><code>UUID</code></a> and array of <a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util"><code>UUID</code></a>s</li> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a> and array of <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a>s</li> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html?is-external=true" title="class or interface in java.sql"><code>Timestamp</code></a> and array of <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html?is-external=true" title="class or interface in java.sql"><code>Timestamp</code></a>s</li> |
| <li>Enums and array of enums</li> |
| <li> |
| Maps, collections and array of objects (but objects inside |
| them will still be converted if they are binary) |
| </li> |
| </ul> |
| <h1 class="header">Working With Maps and Collections</h1> |
| All maps and collections in the binary objects are serialized automatically. When working |
| with different platforms, e.g. C++ or .NET, Ignite will automatically pick the most |
| adequate collection or map in either language. For example, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util"><code>ArrayList</code></a> in Java will become |
| <code>List</code> in C#, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html?is-external=true" title="class or interface in java.util"><code>LinkedList</code></a> in Java is <a href="http://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html?is-external=true" title="class or interface in java.util"><code>LinkedList</code></a> in C#, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util"><code>HashMap</code></a> |
| in Java is <code>Dictionary</code> in C#, and <a href="http://docs.oracle.com/javase/8/docs/api/java/util/TreeMap.html?is-external=true" title="class or interface in java.util"><code>TreeMap</code></a> in Java becomes <code>SortedDictionary</code> |
| in C#, etc. |
| <h1 class="header">Building Binary Objects</h1> |
| Ignite comes with <a href="../../../org/apache/ignite/binary/BinaryObjectBuilder.html" title="interface in org.apache.ignite.binary"><code>BinaryObjectBuilder</code></a> which allows to build binary objects dynamically: |
| <pre name=code class=java> |
| BinaryBuilder builder = Ignition.ignite().binary().builder(); |
| |
| builder.typeId("MyObject"); |
| |
| builder.stringField("fieldA", "A"); |
| build.intField("fieldB", "B"); |
| |
| BinaryObject binaryObj = builder.build(); |
| </pre> |
| For the cases when class definition is present |
| in the class path, it is also possible to populate a standard POJO and then |
| convert it to binary format, like so: |
| <pre name=code class=java> |
| MyObject obj = new MyObject(); |
| |
| obj.setFieldA("A"); |
| obj.setFieldB(123); |
| |
| BinaryObject binaryObj = Ignition.ignite().binary().toBinary(obj); |
| </pre> |
| NOTE: you don't need to convert typed objects to binary format before storing |
| them in cache, Ignite will do that automatically. |
| <h1 class="header">Binary Metadata</h1> |
| Even though Ignite binary protocol only works with hash codes for type and field names |
| to achieve better performance, Ignite provides metadata for all binary types which |
| can be queried ar runtime via any of the <a href="../../../org/apache/ignite/IgniteBinary.html#type-java.lang.Class-"><code>type(Class)</code></a> |
| methods. Having metadata also allows for proper formatting of <code>BinaryObject#toString()</code> method, |
| even when binary objects are kept in binary format only, which may be necessary for audit reasons. |
| <h1 class="header">Dynamic Structure Changes</h1> |
| Since objects are always cached in the binary binary format, server does not need to |
| be aware of the class definitions. Moreover, if class definitions are not present or not |
| used on the server, then clients can continuously change the structure of the binary |
| objects without having to restart the cluster. For example, if one client stores a |
| certain class with fields A and B, and another client stores the same class with |
| fields B and C, then the server-side binary object will have the fields A, B, and C. |
| As the structure of a binary object changes, the new fields become available for SQL queries |
| automatically. |
| <h1 class="header">Configuration</h1> |
| By default all your objects are considered as binary and no specific configuration is needed. |
| The only requirement Ignite imposes is that your object has an empty |
| constructor. Note, that since server side does not have to know the class definition, |
| you only need to list binary objects in configuration on the client side. However, if you |
| list them on the server side as well, then you get the ability to deserialize binary objects |
| into concrete types on the server as well as on the client. |
| <p> |
| Here is an example of binary configuration (note that star (*) notation is supported): |
| <pre name=code class=xml> |
| ... |
| <!-- Explicit binary objects configuration. --> |
| <property name="marshaller"> |
| <bean class="org.apache.ignite.marshaller.binary.BinaryMarshaller"> |
| <property name="classNames"> |
| <list> |
| <value>my.package.for.binary.objects.*</value> |
| <value>org.apache.ignite.examples.client.binary.Employee</value> |
| </list> |
| </property> |
| </bean> |
| </property> |
| ... |
| </pre> |
| or from code: |
| <pre name=code class=java> |
| IgniteConfiguration cfg = new IgniteConfiguration(); |
| |
| BinaryMarshaller marsh = new BinaryMarshaller(); |
| |
| marsh.setClassNames(Arrays.asList( |
| Employee.class.getName(), |
| Address.class.getName()) |
| ); |
| |
| cfg.setMarshaller(marsh); |
| </pre> |
| You can also specify class name for a binary object via <a href="../../../org/apache/ignite/binary/BinaryTypeConfiguration.html" title="class in org.apache.ignite.binary"><code>BinaryTypeConfiguration</code></a>. |
| Do it in case if you need to override other configuration properties on per-type level, like |
| ID-mapper, or serializer. |
| <h1 class="header">Custom Affinity Keys</h1> |
| Often you need to specify an alternate key (not the cache key) for affinity routing whenever |
| storing objects in cache. For example, if you are caching <code>Employee</code> object with |
| <code>Organization</code>, and want to colocate employees with organization they work for, |
| so you can process them together, you need to specify an alternate affinity key. |
| With binary objects you would have to do it as following: |
| <pre name=code class=xml> |
| <property name="marshaller"> |
| <bean class="org.gridgain.grid.marshaller.binary.BinaryMarshaller"> |
| ... |
| <property name="typeConfigurations"> |
| <list> |
| <bean class="org.apache.ignite.binary.BinaryTypeConfiguration"> |
| <property name="className" value="org.apache.ignite.examples.client.binary.EmployeeKey"/> |
| <property name="affinityKeyFieldName" value="organizationId"/> |
| </bean> |
| </list> |
| </property> |
| ... |
| </bean> |
| </property> |
| </pre> |
| <h1 class="header">Serialization</h1> |
| Serialization and deserialization works out-of-the-box in Ignite. However, you can provide your own custom |
| serialization logic by optionally implementing <a href="../../../org/apache/ignite/binary/Binarylizable.html" title="interface in org.apache.ignite.binary"><code>Binarylizable</code></a> interface, like so: |
| <pre name=code class=java> |
| public class Address implements BinaryMarshalAware { |
| private String street; |
| private int zip; |
| |
| // Empty constructor required for binary deserialization. |
| public Address() {} |
| |
| @Override public void writeBinary(BinaryWriter writer) throws BinaryException { |
| writer.writeString("street", street); |
| writer.writeInt("zip", zip); |
| } |
| |
| @Override public void readBinary(BinaryReader reader) throws BinaryException { |
| street = reader.readString("street"); |
| zip = reader.readInt("zip"); |
| } |
| } |
| </pre> |
| Alternatively, if you cannot change class definitions, you can provide custom serialization |
| logic in <a href="../../../org/apache/ignite/binary/BinarySerializer.html" title="interface in org.apache.ignite.binary"><code>BinarySerializer</code></a> either globally in |
| <a href="../../../org/apache/ignite/configuration/BinaryConfiguration.html" title="class in org.apache.ignite.configuration"><code>BinaryConfiguration</code></a> or |
| for a specific type via <a href="../../../org/apache/ignite/binary/BinaryTypeConfiguration.html" title="class in org.apache.ignite.binary"><code>BinaryTypeConfiguration</code></a> instance. |
| <p> |
| Similar to java serialization you can use <code>writeReplace()</code> and <code>readResolve()</code> methods. |
| <ul> |
| <li> |
| <code>readResolve</code> is defined as follows: <code>ANY-ACCESS-MODIFIER Object readResolve()</code>. |
| It may be used to replace the de-serialized object by another one of your choice. |
| </li> |
| <li> |
| <code>writeReplace</code> is defined as follows: <code>ANY-ACCESS-MODIFIER Object writeReplace()</code>. This method |
| allows the developer to provide a replacement object that will be serialized instead of the original one. |
| </li> |
| </ul> |
| |
| <h1 class="header">Custom ID Mappers</h1> |
| Ignite implementation uses name hash codes to generate IDs for class names or field names |
| internally. However, in cases when you want to provide your own ID mapping schema, |
| you can provide your own <a href="../../../org/apache/ignite/binary/BinaryIdMapper.html" title="interface in org.apache.ignite.binary"><code>BinaryIdMapper</code></a> implementation. |
| <p> |
| ID-mapper may be provided either globally in <a href="../../../org/apache/ignite/configuration/BinaryConfiguration.html" title="class in org.apache.ignite.configuration"><code>BinaryConfiguration</code></a>, |
| or for a specific type via <a href="../../../org/apache/ignite/binary/BinaryTypeConfiguration.html" title="class in org.apache.ignite.binary"><code>BinaryTypeConfiguration</code></a> instance. |
| <h1 class="header">Query Indexing</h1> |
| Binary objects can be indexed for querying by specifying index fields in |
| <a href="../../../org/apache/ignite/cache/QueryEntity.html" title="class in org.apache.ignite.cache"><code>QueryEntity</code></a> inside of specific |
| <a href="../../../org/apache/ignite/configuration/CacheConfiguration.html" title="class in org.apache.ignite.configuration"><code>CacheConfiguration</code></a> instance, |
| like so: |
| <pre name=code class=xml> |
| ... |
| <bean class="org.apache.ignite.cache.CacheConfiguration"> |
| ... |
| <property name="queryEntities"> |
| <list> |
| <bean class="QueryEntity"> |
| <property name="type" value="Employee"/> |
| |
| <!-- Fields available from query. --> |
| <property name="fields"> |
| <map> |
| <entry key="name" value="java.lang.String"/> |
| |
| <!-- Nested binary objects can also be indexed. --> |
| <entry key="address.zip" value="java.lang.Integer" /> |
| </map> |
| </property> |
| |
| <!-- Aliases for full property name in dot notation. --> |
| <property name="fields"> |
| <map> |
| <entry key="address.zip" value="zip" /> |
| </map> |
| </property> |
| |
| <!-- Indexes configuration. --> |
| <property name="indexes"> |
| <list> |
| <bean class="org.apache.ignite.cache.QueryIndex"> |
| <property name="fields"> |
| <map> |
| <!-- The boolean value is the acceding flag. --> |
| <entry key="name" value="true"/> |
| </map> |
| </property> |
| </bean> |
| </list> |
| </property> |
| </bean> |
| </list> |
| </property> |
| </bean> |
| </pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../../org/apache/ignite/binary/BinaryObject.html" title="interface in org.apache.ignite.binary">BinaryObject</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#buildEnum-java.lang.String-int-">buildEnum</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName, |
| int ord)</code> |
| <div class="block">Create enum object using value.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/binary/BinaryObject.html" title="interface in org.apache.ignite.binary">BinaryObject</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#buildEnum-java.lang.String-java.lang.String-">buildEnum</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Create enum object using name.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/binary/BinaryObjectBuilder.html" title="interface in org.apache.ignite.binary">BinaryObjectBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#builder-org.apache.ignite.binary.BinaryObject-">builder</a></span>(<a href="../../../org/apache/ignite/binary/BinaryObject.html" title="interface in org.apache.ignite.binary">BinaryObject</a> binaryObj)</code> |
| <div class="block">Creates binary builder initialized by existing binary object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/binary/BinaryObjectBuilder.html" title="interface in org.apache.ignite.binary">BinaryObjectBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#builder-java.lang.String-">builder</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName)</code> |
| <div class="block">Creates new binary builder.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/binary/BinaryType.html" title="interface in org.apache.ignite.binary">BinaryType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#registerEnum-java.lang.String-java.util.Map-">registerEnum</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> vals)</code> |
| <div class="block">Register enum type.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#toBinary-java.lang.Object-">toBinary</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> |
| <div class="block">Converts provided object to instance of <a href="../../../org/apache/ignite/binary/BinaryObject.html" title="interface in org.apache.ignite.binary"><code>BinaryObject</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/binary/BinaryType.html" title="interface in org.apache.ignite.binary">BinaryType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#type-java.lang.Class-">type</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls)</code> |
| <div class="block">Gets metadata for provided class.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/binary/BinaryType.html" title="interface in org.apache.ignite.binary">BinaryType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#type-int-">type</a></span>(int typeId)</code> |
| <div class="block">Gets metadata for provided type ID.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/ignite/binary/BinaryType.html" title="interface in org.apache.ignite.binary">BinaryType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#type-java.lang.String-">type</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName)</code> |
| <div class="block">Gets metadata for provided class name.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#typeId-java.lang.String-">typeId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName)</code> |
| <div class="block">Gets type ID for given type name.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../org/apache/ignite/binary/BinaryType.html" title="interface in org.apache.ignite.binary">BinaryType</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/ignite/IgniteBinary.html#types--">types</a></span>()</code> |
| <div class="block">Gets metadata for all known types.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="typeId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>typeId</h4> |
| <pre>int typeId(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName)</pre> |
| <div class="block">Gets type ID for given type name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeName</code> - Type name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Type ID.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toBinary-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toBinary</h4> |
| <pre><T> T toBinary(@Nullable |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj) |
| throws <a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></pre> |
| <div class="block">Converts provided object to instance of <a href="../../../org/apache/ignite/binary/BinaryObject.html" title="interface in org.apache.ignite.binary"><code>BinaryObject</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - Object to convert.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Converted object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></code> - In case of error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="builder-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>builder</h4> |
| <pre><a href="../../../org/apache/ignite/binary/BinaryObjectBuilder.html" title="interface in org.apache.ignite.binary">BinaryObjectBuilder</a> builder(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName) |
| throws <a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></pre> |
| <div class="block">Creates new binary builder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeName</code> - Type name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Newly binary builder.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="builder-org.apache.ignite.binary.BinaryObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>builder</h4> |
| <pre><a href="../../../org/apache/ignite/binary/BinaryObjectBuilder.html" title="interface in org.apache.ignite.binary">BinaryObjectBuilder</a> builder(<a href="../../../org/apache/ignite/binary/BinaryObject.html" title="interface in org.apache.ignite.binary">BinaryObject</a> binaryObj) |
| throws <a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></pre> |
| <div class="block">Creates binary builder initialized by existing binary object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>binaryObj</code> - Binary object to initialize builder.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Binary builder.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="type-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre><a href="../../../org/apache/ignite/binary/BinaryType.html" title="interface in org.apache.ignite.binary">BinaryType</a> type(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls) |
| throws <a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></pre> |
| <div class="block">Gets metadata for provided class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cls</code> - Class.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></code> - In case of error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="type-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre><a href="../../../org/apache/ignite/binary/BinaryType.html" title="interface in org.apache.ignite.binary">BinaryType</a> type(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName) |
| throws <a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></pre> |
| <div class="block">Gets metadata for provided class name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeName</code> - Type name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></code> - In case of error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="type-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre><a href="../../../org/apache/ignite/binary/BinaryType.html" title="interface in org.apache.ignite.binary">BinaryType</a> type(int typeId) |
| throws <a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></pre> |
| <div class="block">Gets metadata for provided type ID.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeId</code> - Type ID.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></code> - In case of error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="types--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>types</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../org/apache/ignite/binary/BinaryType.html" title="interface in org.apache.ignite.binary">BinaryType</a>> types() |
| throws <a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></pre> |
| <div class="block">Gets metadata for all known types.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metadata.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></code> - In case of error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildEnum-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildEnum</h4> |
| <pre><a href="../../../org/apache/ignite/binary/BinaryObject.html" title="interface in org.apache.ignite.binary">BinaryObject</a> buildEnum(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName, |
| int ord) |
| throws <a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></pre> |
| <div class="block">Create enum object using value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeName</code> - Type name.</dd> |
| <dd><code>ord</code> - Ordinal.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Enum object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildEnum-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildEnum</h4> |
| <pre><a href="../../../org/apache/ignite/binary/BinaryObject.html" title="interface in org.apache.ignite.binary">BinaryObject</a> buildEnum(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name) |
| throws <a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></pre> |
| <div class="block">Create enum object using name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeName</code> - Type name.</dd> |
| <dd><code>name</code> - Name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Enum object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerEnum-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>registerEnum</h4> |
| <pre><a href="../../../org/apache/ignite/binary/BinaryType.html" title="interface in org.apache.ignite.binary">BinaryType</a> registerEnum(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> typeName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> vals) |
| throws <a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></pre> |
| <div class="block">Register enum type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeName</code> - Type name.</dd> |
| <dd><code>vals</code> - Mapping of enum constant names to ordinals.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Binary type for registered enum.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../org/apache/ignite/binary/BinaryObjectException.html" title="class in org.apache.ignite.binary">BinaryObjectException</a></code></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="class-use/IgniteBinary.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 class="aboutLanguage">Ignite - In-Memory Data Fabric</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/apache/ignite/IgniteAuthenticationException.html" title="class in org.apache.ignite"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/ignite/IgniteCache.html" title="interface in org.apache.ignite"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/ignite/IgniteBinary.html" target="_top">Frames</a></li> |
| <li><a href="IgniteBinary.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2018 Copyright © Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Fabric</b> </td> <td>: ver. <strong>2.6.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: July 10 2018 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |
