You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by ag...@apache.org on 2015/11/04 11:28:14 UTC
[11/16] ignite git commit: IGNITE-950 - Javadoc.
IGNITE-950 - Javadoc.
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo
Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/ed9d922a
Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/ed9d922a
Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/ed9d922a
Branch: refs/heads/ignite-950-new
Commit: ed9d922a97823a9dd1968b9dc2fbbb3c4a6cb534
Parents: 9fae3cd
Author: Alexey Goncharuk <al...@gmail.com>
Authored: Wed Nov 4 12:47:05 2015 +0300
Committer: Alexey Goncharuk <al...@gmail.com>
Committed: Wed Nov 4 12:47:05 2015 +0300
----------------------------------------------------------------------
.../org/apache/ignite/binary/BinaryField.java | 2 +-
.../binary/BinaryInvalidTypeException.java | 2 +-
.../org/apache/ignite/binary/BinaryObject.java | 64 ++++++++++----------
.../ignite/binary/BinaryObjectBuilder.java | 32 +++++-----
.../ignite/binary/BinaryObjectException.java | 8 +--
.../apache/ignite/binary/BinaryRawReader.java | 4 +-
.../apache/ignite/binary/BinaryRawWriter.java | 4 +-
.../org/apache/ignite/binary/BinaryReader.java | 2 +-
.../apache/ignite/binary/BinarySerializer.java | 10 +--
.../org/apache/ignite/binary/BinaryType.java | 16 ++---
.../ignite/binary/BinaryTypeConfiguration.java | 8 +--
.../ignite/binary/BinaryTypeIdMapper.java | 8 +--
.../org/apache/ignite/binary/BinaryWriter.java | 4 +-
.../org/apache/ignite/binary/Binarylizable.java | 10 +--
14 files changed, 87 insertions(+), 87 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryField.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryField.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryField.java
index efc5a7a..c4be5bf 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryField.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryField.java
@@ -18,7 +18,7 @@
package org.apache.ignite.binary;
/**
- * Portable object field. Can be used to speed object field lookup.
+ * Binary object field. Can be used to speed object field lookup.
*/
public interface BinaryField {
/**
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryInvalidTypeException.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryInvalidTypeException.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryInvalidTypeException.java
index 63f7be6..2fe1e79 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryInvalidTypeException.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryInvalidTypeException.java
@@ -20,7 +20,7 @@ package org.apache.ignite.binary;
import org.jetbrains.annotations.Nullable;
/**
- * Exception indicating that class needed for deserialization of portable object does not exist.
+ * Exception indicating that class needed for deserialization of binary object does not exist.
* <p>
* Thrown from {@link BinaryObject#deserialize()} method.
*/
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryObject.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryObject.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryObject.java
index 403871e..12a333b 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryObject.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryObject.java
@@ -25,23 +25,23 @@ import java.util.TreeMap;
import org.apache.ignite.marshaller.portable.PortableMarshaller;
/**
- * Wrapper for portable object in portable binary format. Once an object is defined as portable,
- * Ignite will always store it in memory in the portable (i.e. binary) format.
- * User can choose to work either with the portable format or with the deserialized form
+ * Wrapper for binary object in binary format. Once an object is defined as binary,
+ * Ignite will always store it in memory in the 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>
* <b>NOTE:</b> user does not need to (and should not) implement this interface directly.
* <p>
- * To work with the portable format directly, user should create a cache projection
- * over {@code PortableObject} class and then retrieve individual fields as needed:
+ * To work with the binary format directly, user should create a cache projection
+ * over {@code BinaryObject} class and then retrieve individual fields as needed:
* <pre name=code class=java>
- * IgniteCache<PortableObject, PortableObject> prj = cache.withKeepBinary();
+ * IgniteCache<BinaryObject, BinaryObject> prj = cache.withKeepBinary();
*
- * // Convert instance of MyKey to portable format.
- * // We could also use GridPortableBuilder to create the key in portable format directly.
- * PortableObject key = grid.binary().toBinary(new MyKey());
+ * // Convert instance of MyKey to binary format.
+ * // We could also use BinaryObjectBuilder to create the key in binary format directly.
+ * BinaryObject key = ignite.binary().toBinary(new MyKey());
*
- * PortableObject val = prj.get(key);
+ * BinaryObject val = prj.get(key);
*
* String field = val.field("myFieldName");
* </pre>
@@ -58,59 +58,59 @@ import org.apache.ignite.marshaller.portable.PortableMarshaller;
* String fieldVal = val.getMyFieldName();
* </pre>
* <h1 class="header">Working With Maps and Collections</h1>
- * All maps and collections in the portable objects are serialized automatically. When working
+ * All maps and collections in 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, {@link ArrayList} in Java will become
* {@code List} in C#, {@link LinkedList} in Java is {@link LinkedList} in C#, {@link HashMap}
* in Java is {@code Dictionary} in C#, and {@link TreeMap} in Java becomes {@code SortedDictionary}
* in C#, etc.
* <h1 class="header">Dynamic Structure Changes</h1>
- * Since objects are always cached in the portable binary format, server does not need to
+ * Since objects are always cached in the 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 portable
+ * 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 portable object will have the fields A, B, and C.
- * As the structure of a portable object changes, the new fields become available for SQL queries
+ * 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">Building Portable Objects</h1>
- * Ignite comes with {@link BinaryObjectBuilder} which allows to build portable objects dynamically:
+ * <h1 class="header">Building Binary Objects</h1>
+ * Ignite comes with {@link BinaryObjectBuilder} which allows to build binary objects dynamically:
* <pre name=code class=java>
- * PortableBuilder builder = Ignition.ignite().binary().builder("org.project.MyObject");
+ * BinaryObjectBuilder builder = Ignition.ignite().binary().builder("org.project.MyObject");
*
* builder.setField("fieldA", "A");
* builder.setField("fieldB", "B");
*
- * PortableObject portableObj = builder.build();
+ * 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 portable format, like so:
+ * convert it to binary format, like so:
* <pre name=code class=java>
* MyObject obj = new MyObject();
*
* obj.setFieldA("A");
* obj.setFieldB(123);
*
- * PortableObject portableObj = Ignition.ignite().binary().toBinary(obj);
+ * BinaryObject binaryObj = Ignition.ignite().binary().toBinary(obj);
* </pre>
- * <h1 class="header">Portable Metadata</h1>
- * Even though Ignite portable protocol only works with hash codes for type and field names
- * to achieve better performance, Ignite provides metadata for all portable types which
+ * <h1 class="header">Binary Type 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 {@link org.apache.ignite.IgniteBinary#metadata(Class)}
- * methods. Having metadata also allows for proper formatting of {@code PortableObject.toString()} method,
- * even when portable objects are kept in binary format only, which may be necessary for audit reasons.
+ * methods. Having metadata also allows for proper formatting of {@code BinaryObject.toString()} method,
+ * even when binary objects are kept in binary format only, which may be necessary for audit reasons.
*/
public interface BinaryObject extends Serializable, Cloneable {
/**
- * Gets portable object type ID.
+ * Gets binary object type ID.
*
* @return Type ID.
*/
public int typeId();
/**
- * Gets meta data for this portable object.
+ * Gets type information for this binary object.
*
* @return Meta data.
* @throws BinaryObjectException In case of error.
@@ -147,18 +147,18 @@ public interface BinaryObject extends Serializable, Cloneable {
public BinaryField fieldDescriptor(String fieldName) throws BinaryObjectException;
/**
- * Gets fully deserialized instance of portable object.
+ * Gets fully deserialized instance of binary object.
*
- * @return Fully deserialized instance of portable object.
+ * @return Fully deserialized instance of binary object.
* @throws BinaryInvalidTypeException If class doesn't exist.
* @throws BinaryObjectException In case of any other error.
*/
public <T> T deserialize() throws BinaryObjectException;
/**
- * Copies this portable object.
+ * Copies this binary object.
*
- * @return Copy of this portable object.
+ * @return Copy of this binary object.
*/
public BinaryObject clone() throws CloneNotSupportedException;
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryObjectBuilder.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryObjectBuilder.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryObjectBuilder.java
index 3d1f0af..fb29331 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryObjectBuilder.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryObjectBuilder.java
@@ -20,23 +20,23 @@ package org.apache.ignite.binary;
import org.jetbrains.annotations.Nullable;
/**
- * Portable object builder. Provides ability to build portable objects dynamically without having class definitions.
+ * Binary object builder. Provides ability to build binary objects dynamically without having class definitions.
* <p>
- * Here is an example of how a portable object can be built dynamically:
+ * Here is an example of how a binary object can be built dynamically:
* <pre name=code class=java>
- * PortableBuilder builder = Ignition.ignite().binary().builder("org.project.MyObject");
+ * BinaryObjectBuilder builder = Ignition.ignite().binary().builder("org.project.MyObject");
*
* builder.setField("fieldA", "A");
* builder.setField("fieldB", "B");
*
- * PortableObject portableObj = builder.build();
+ * BinaryObject binaryObj = builder.build();
* </pre>
*
* <p>
- * Also builder can be initialized by existing portable object. This allows changing some fields without affecting
+ * Also builder can be initialized by existing binary object. This allows changing some fields without affecting
* other fields.
* <pre name=code class=java>
- * PortableBuilder builder = Ignition.ignite().binary().builder(person);
+ * BinaryObjectBuilder builder = Ignition.ignite().binary().builder(person);
*
* builder.setField("name", "John");
*
@@ -44,20 +44,20 @@ import org.jetbrains.annotations.Nullable;
* </pre>
* </p>
*
- * If you need to modify nested portable object you can get builder for nested object using
+ * If you need to modify nested binary object you can get builder for nested object using
* {@link #getField(String)}, changes made on nested builder will affect parent object,
* for example:
*
* <pre name=code class=java>
- * PortableBuilder personBuilder = grid.binary().createBuilder(personPortableObj);
- * PortableBuilder addressBuilder = personBuilder.setField("address");
+ * BinaryObjectBuilder personBuilder = grid.binary().createBuilder(personBinaryObj);
+ * BinaryObjectBuilder addressBuilder = personBuilder.setField("address");
*
* addressBuilder.setField("city", "New York");
*
- * personPortableObj = personBuilder.build();
+ * personBinaryObj = personBuilder.build();
*
* // Should be "New York".
- * String city = personPortableObj.getField("address").getField("city");
+ * String city = personBinaryObj.getField("address").getField("city");
* </pre>
*
* @see org.apache.ignite.IgniteBinary#builder(int)
@@ -67,7 +67,7 @@ import org.jetbrains.annotations.Nullable;
public interface BinaryObjectBuilder {
/**
* Returns value assigned to the specified field.
- * If the value is a portable object instance of {@code GridPortableBuilder} will be returned,
+ * If the value is a binary object instance of {@code BinaryObjectBuilder} will be returned,
* which can be modified.
* <p>
* Collections and maps returned from this method are modifiable.
@@ -101,7 +101,7 @@ public interface BinaryObjectBuilder {
/**
* Sets field value.
* <p>
- * This method should be used if field is portable object.
+ * This method should be used if field is binary object.
*
* @param name Field name.
* @param builder Builder for object field.
@@ -117,7 +117,7 @@ public interface BinaryObjectBuilder {
public BinaryObjectBuilder removeField(String fieldName);
/**
- * Sets hash code for resulting portable object returned by {@link #build()} method.
+ * Sets hash code for resulting binary object returned by {@link #build()} method.
* <p>
* If not set {@code 0} is used.
*
@@ -127,9 +127,9 @@ public interface BinaryObjectBuilder {
public BinaryObjectBuilder hashCode(int hashCode);
/**
- * Builds portable object.
+ * Builds binary object.
*
- * @return Portable object.
+ * @return Binary object.
* @throws BinaryObjectException In case of error.
*/
public BinaryObject build() throws BinaryObjectException;
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryObjectException.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryObjectException.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryObjectException.java
index 124f267..4305382 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryObjectException.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryObjectException.java
@@ -21,14 +21,14 @@ import org.apache.ignite.IgniteException;
import org.jetbrains.annotations.Nullable;
/**
- * Exception indicating portable object serialization error.
+ * Exception indicating binary object serialization error.
*/
public class BinaryObjectException extends IgniteException {
/** */
private static final long serialVersionUID = 0L;
/**
- * Creates portable exception with error message.
+ * Creates binary exception with error message.
*
* @param msg Error message.
*/
@@ -37,7 +37,7 @@ public class BinaryObjectException extends IgniteException {
}
/**
- * Creates portable exception with {@link Throwable} as a cause.
+ * Creates binary exception with {@link Throwable} as a cause.
*
* @param cause Cause.
*/
@@ -46,7 +46,7 @@ public class BinaryObjectException extends IgniteException {
}
/**
- * Creates portable exception with error message and {@link Throwable} as a cause.
+ * Creates binary exception with error message and {@link Throwable} as a cause.
*
* @param msg Error message.
* @param cause Cause.
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryRawReader.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryRawReader.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryRawReader.java
index 665b5ea..7ff515a 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryRawReader.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryRawReader.java
@@ -26,9 +26,9 @@ import java.util.UUID;
import org.jetbrains.annotations.Nullable;
/**
- * Raw reader for portable objects. Raw reader does not use field name hash codes, therefore,
+ * Raw reader for binary objects. Raw reader does not use field name hash codes, therefore,
* making the format even more compact. However, if the raw reader is used,
- * dynamic structure changes to the portable objects are not supported.
+ * dynamic structure changes to the binary objects are not supported.
*/
public interface BinaryRawReader {
/**
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryRawWriter.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryRawWriter.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryRawWriter.java
index 2081774..f283c06 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryRawWriter.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryRawWriter.java
@@ -26,9 +26,9 @@ import java.util.UUID;
import org.jetbrains.annotations.Nullable;
/**
- * Raw writer for portable object. Raw writer does not write field name hash codes, therefore,
+ * Raw writer for binary object. Raw writer does not write field name hash codes, therefore,
* making the format even more compact. However, if the raw writer is used,
- * dynamic structure changes to the portable objects are not supported.
+ * dynamic structure changes to the binary objects are not supported.
*/
public interface BinaryRawWriter {
/**
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryReader.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryReader.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryReader.java
index d49330d..8a89a87 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryReader.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryReader.java
@@ -282,7 +282,7 @@ public interface BinaryReader {
/**
* Gets raw reader. Raw reader does not use field name hash codes, therefore,
* making the format even more compact. However, if the raw reader is used,
- * dynamic structure changes to the portable objects are not supported.
+ * dynamic structure changes to the binary objects are not supported.
*
* @return Raw reader.
*/
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinarySerializer.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinarySerializer.java b/modules/core/src/main/java/org/apache/ignite/binary/BinarySerializer.java
index 45ea923..6fa4237 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinarySerializer.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinarySerializer.java
@@ -20,20 +20,20 @@ package org.apache.ignite.binary;
import org.apache.ignite.marshaller.portable.PortableMarshaller;
/**
- * Interface that allows to implement custom serialization logic for portable objects.
+ * Interface that allows to implement custom serialization logic for binary objects.
* Can be used instead of {@link Binarylizable} in case if the class
* cannot be changed directly.
* <p>
- * Portable serializer can be configured for all portable objects via
+ * Binary serializer can be configured for all binary objects via
* {@link PortableMarshaller#getSerializer()} method, or for a specific
- * portable type via {@link BinaryTypeConfiguration#getSerializer()} method.
+ * binary type via {@link BinaryTypeConfiguration#getSerializer()} method.
*/
public interface BinarySerializer {
/**
* Writes fields to provided writer.
*
* @param obj Empty object.
- * @param writer Portable object writer.
+ * @param writer Binary object writer.
* @throws BinaryObjectException In case of error.
*/
public void writeBinary(Object obj, BinaryWriter writer) throws BinaryObjectException;
@@ -42,7 +42,7 @@ public interface BinarySerializer {
* Reads fields from provided reader.
*
* @param obj Empty object
- * @param reader Portable object reader.
+ * @param reader Binary object reader.
* @throws BinaryObjectException In case of error.
*/
public void readBinary(Object obj, BinaryReader reader) throws BinaryObjectException;
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryType.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryType.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryType.java
index 8988c9d..d149fd4 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryType.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryType.java
@@ -20,23 +20,23 @@ package org.apache.ignite.binary;
import java.util.Collection;
/**
- * Portable type meta data. Metadata for portable types can be accessed from any of the
+ * Binary type meta data. Metadata for binary types can be accessed from any of the
* {@link org.apache.ignite.IgniteBinary#metadata(String)} methods.
- * Having metadata also allows for proper formatting of {@code PortableObject#toString()} method,
- * even when portable objects are kept in binary format only, which may be necessary for audit reasons.
+ * Having metadata also allows for proper formatting of {@code BinaryObject#toString()} method,
+ * even when binary objects are kept in binary format only, which may be necessary for audit reasons.
*/
public interface BinaryType {
/**
- * Gets portable type name.
+ * Gets binary type name.
*
- * @return Portable type name.
+ * @return Binary type name.
*/
public String typeName();
/**
- * Gets collection of all field names for this portable type.
+ * Gets collection of all field names for this binary type.
*
- * @return Collection of all field names for this portable type.
+ * @return Collection of all field names for this binary type.
*/
public Collection<String> fields();
@@ -49,7 +49,7 @@ public interface BinaryType {
public String fieldTypeName(String fieldName);
/**
- * Portable objects can optionally specify custom key-affinity mapping in the
+ * Binary objects can optionally specify custom key-affinity mapping in the
* configuration. This method returns the name of the field which should be
* used for the key-affinity mapping.
*
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryTypeConfiguration.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryTypeConfiguration.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryTypeConfiguration.java
index 3a09a63..3b73edb 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryTypeConfiguration.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryTypeConfiguration.java
@@ -22,13 +22,13 @@ import org.apache.ignite.internal.util.typedef.internal.S;
import org.apache.ignite.marshaller.portable.PortableMarshaller;
/**
- * Defines configuration properties for a specific portable type. Providing per-type
- * configuration is optional, as it is generally enough, and also optional, to provide global portable
+ * Defines configuration properties for a specific binary type. Providing per-type
+ * configuration is optional, as it is generally enough, and also optional, to provide global binary
* configuration using {@link PortableMarshaller#setClassNames(Collection)}.
* However, this class allows you to change configuration properties for a specific
- * portable type without affecting configuration for other portable types.
+ * binary type without affecting configuration for other binary types.
* <p>
- * Per-type portable configuration can be specified in {@link PortableMarshaller#getTypeConfigurations()} method.
+ * Per-type binary configuration can be specified in {@link PortableMarshaller#getTypeConfigurations()} method.
*/
public class BinaryTypeConfiguration {
/** Class name. */
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryTypeIdMapper.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryTypeIdMapper.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryTypeIdMapper.java
index 8995f79..4825f8c 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryTypeIdMapper.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryTypeIdMapper.java
@@ -20,17 +20,17 @@ package org.apache.ignite.binary;
import org.apache.ignite.marshaller.portable.PortableMarshaller;
/**
- * Type and field ID mapper for portable objects. Ignite never writes full
+ * Type and field ID mapper for binary objects. Ignite never writes full
* strings for field or type names. Instead, for performance reasons, Ignite
* writes integer hash codes for type and field names. It has been tested that
* hash code conflicts for the type names or the field names
* within the same type are virtually non-existent and, to gain performance, it is safe
* to work with hash codes. For the cases when hash codes for different types or fields
- * actually do collide {@code PortableIdMapper} allows to override the automatically
+ * actually do collide {@code BinaryTypeIdMapper} allows to override the automatically
* generated hash code IDs for the type and field names.
* <p>
- * Portable ID mapper can be configured for all portable objects via {@link PortableMarshaller#getIdMapper()} method,
- * or for a specific portable type via {@link BinaryTypeConfiguration#getIdMapper()} method.
+ * Binary ID mapper can be configured for all binary objects via {@link PortableMarshaller#getIdMapper()} method,
+ * or for a specific binary type via {@link BinaryTypeConfiguration#getIdMapper()} method.
*/
public interface BinaryTypeIdMapper {
/**
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/BinaryWriter.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/BinaryWriter.java b/modules/core/src/main/java/org/apache/ignite/binary/BinaryWriter.java
index 20217e3..0ea4416 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/BinaryWriter.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/BinaryWriter.java
@@ -26,7 +26,7 @@ import java.util.UUID;
import org.jetbrains.annotations.Nullable;
/**
- * Writer for portable object used in {@link Binarylizable} implementations.
+ * Writer for binary object used in {@link Binarylizable} implementations.
* Useful for the cases when user wants a fine-grained control over serialization.
* <p>
* Note that Ignite never writes full strings for field or type names. Instead,
@@ -265,7 +265,7 @@ public interface BinaryWriter {
/**
* Gets raw writer. Raw writer does not write field name hash codes, therefore,
* making the format even more compact. However, if the raw writer is used,
- * dynamic structure changes to the portable objects are not supported.
+ * dynamic structure changes to the binary objects are not supported.
*
* @return Raw writer.
*/
http://git-wip-us.apache.org/repos/asf/ignite/blob/ed9d922a/modules/core/src/main/java/org/apache/ignite/binary/Binarylizable.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/binary/Binarylizable.java b/modules/core/src/main/java/org/apache/ignite/binary/Binarylizable.java
index d360fb7..d09ffc8 100644
--- a/modules/core/src/main/java/org/apache/ignite/binary/Binarylizable.java
+++ b/modules/core/src/main/java/org/apache/ignite/binary/Binarylizable.java
@@ -19,13 +19,13 @@ package org.apache.ignite.binary;
/**
* Interface that allows to implement custom serialization
- * logic for portable objects. IgniteObject is not required
+ * logic for binary objects. IgniteObject is not required
* to implement this interface, in which case Ignite will automatically
- * serialize portable objects using reflection.
+ * serialize binary objects using reflection.
* <p>
* This interface, in a way, is analogous to {@link java.io.Externalizable}
* interface, which allows users to override default serialization logic,
- * usually for performance reasons. The only difference here is that portable
+ * usually for performance reasons. The only difference here is that binary
* serialization is already very fast and implementing custom serialization
* logic for binary does not provide significant performance gains.
*/
@@ -33,7 +33,7 @@ public interface Binarylizable {
/**
* Writes fields to provided writer.
*
- * @param writer Portable object writer.
+ * @param writer Binary object writer.
* @throws BinaryObjectException In case of error.
*/
public void writeBinary(BinaryWriter writer) throws BinaryObjectException;
@@ -41,7 +41,7 @@ public interface Binarylizable {
/**
* Reads fields from provided reader.
*
- * @param reader Portable object reader.
+ * @param reader Binary object reader.
* @throws BinaryObjectException In case of error.
*/
public void readBinary(BinaryReader reader) throws BinaryObjectException;