Edit Javadoc.

Resolves gh-67.
This commit is contained in:
John Blum
2020-05-06 00:13:17 -07:00
parent 8cf6a8b410
commit bbef166670
2 changed files with 7 additions and 6 deletions

View File

@@ -22,10 +22,11 @@ import org.springframework.lang.NonNull;
/**
* A Spring {@link Converter} interface extension defining a contract to convert
* from a {@literal JSON} {@link String} to a {@link PdxInstance}.
* from {@link String JSON} to a {@link PdxInstance}.
*
* @author John Blum
* @see java.lang.FunctionalInterface
* @see java.lang.String
* @see org.apache.geode.pdx.PdxInstance
* @see org.springframework.core.convert.converter.Converter
* @since 1.3.0
@@ -34,11 +35,11 @@ import org.springframework.lang.NonNull;
public interface JsonToPdxConverter extends Converter<String, PdxInstance> {
/**
* Converts the array of {@link Byte#TYPE bytes} containing {@literal JSON} into a {@link PdxInstance}.
* Converts the array of {@link Byte#TYPE bytes} containing JSON into a {@link PdxInstance}.
*
* @param json array of {@link Byte#TYPE bytes} containing {@literal JSON}
* to convert into a {@link PdxInstance}; must not be {@literal null}.
* @return a {@link PdxInstance} converted from the array of {@link Byte#TYPE bytes} containing {@literal JSON}.
* @param json array of {@link Byte#TYPE bytes} containing JSON to convert into a {@link PdxInstance};
* must not be {@literal null}.
* @return a {@link PdxInstance} converted from the array of {@link Byte#TYPE bytes} containing JSON.
* @see #convert(Object)
*/
default @NonNull PdxInstance convert(@NonNull byte[] json) {

View File

@@ -19,7 +19,7 @@ import org.springframework.core.convert.converter.Converter;
/**
* A Spring {@link Converter} interface extension defining a contract to convert
* from an {@link Object} into a {@literal JSON} {@link String}.
* from an {@link Object} into a {@link String JSON}.
*
* @author John Blum
* @see java.lang.FunctionalInterface