[
https://issues.apache.org/jira/browse/IGNITE-12771?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17057103#comment-17057103
]
Roman Kondakov commented on IGNITE-12771:
-----------------------------------------
[~amashenkov], please take a look. This is a minor javadoc patch.
> Java Doc: Marshaller: behavior of "marshal" method if null parameter passed
> ---------------------------------------------------------------------------
>
> Key: IGNITE-12771
> URL: https://issues.apache.org/jira/browse/IGNITE-12771
> Project: Ignite
> Issue Type: Bug
> Reporter: Roman Kondakov
> Priority: Trivial
> Time Spent: 10m
> Remaining Estimate: 0h
>
> After fix for GG-19786 java docs looks like this:
> {code:java}
> marshal
> void marshal(@Nullable
> @Nullable Object obj,
> OutputStream out)
> throws IgniteCheckedException
> Marshals object to the output stream. This method should not close given
> output stream. Note: null obj will be marshaled to binary null representation.
> Parameters:
> obj - Object to marshal.
> out - Output stream to marshal into.
> Throws:
> IgniteCheckedException - If marshalling failed.
> marshal
> byte[] marshal(@Nullable
> @Nullable Object obj)
> throws IgniteCheckedException
> Marshals object to byte array. Note: null obj will be marshaled to binary
> null representation.
> Parameters:
> obj - Object to marshal.
> Returns:
> Byte array.
> Throws:
> IgniteCheckedException - If marshalling failed.
> unmarshal
> <T> T unmarshal(InputStream in,
> @Nullable
> @Nullable ClassLoader clsLdr)
> throws IgniteCheckedException
> Unmarshals object from the input stream using given class loader. This method
> should not close given input stream.
> Type Parameters:
> T - Type of unmarshalled object.
> Parameters:
> in - Input stream.
> clsLdr - Class loader to use.
> Returns:
> Unmarshalled object.
> Throws:
> IgniteCheckedException - If unmarshalling failed.
> unmarshal
> <T> T unmarshal(byte[] arr,
> @Nullable
> @Nullable ClassLoader clsLdr)
> throws IgniteCheckedException
> Unmarshals object from byte array using given class loader.
> Type Parameters:
> T - Type of unmarshalled object.
> Parameters:
> arr - Byte array.
> clsLdr - Class loader to use.
> Returns:
> Unmarshalled object.
> Throws:
> IgniteCheckedException - If unmarshalling failed.
> {code}
> 1. Doubles for @Nullable
> 2. question what's the point of allowing null value? is not addressed.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
