RMIObjectWriteHandler

package saker.build.thirdparty.saker.rmi.io.writer

public interface RMIObjectWriteHandler

ArrayComponentRMIObjectWriteHandler, DefaultRMIObjectWriteHandler, EnumRMIObjectWriteHandler, RemoteOnlyRMIObjectWriteHandler, RemoteRMIObjectWriteHandler, SelectorRMIObjectWriteHandler, SerializeRMIObjectWriteHandler, WrapperRMIObjectWriteHandler, EnumArrayRMIObjectWriteHandler

RMI object write strategy defining interface.

Write handlers can be bound to method parameters and their results. Handlers are used to define the strategy how the given objects should be transferred over the RMI connection. Each implementation of this interface has an ObjectWriterKind given to it. The RMI streams decide a writing strategy based on this kind. For explanation of each kind, visit the corresponding RMIObjectWriteHandler implementation for them.

Implementers of this interface should adhere to the equals and hashCode contract defined by Object.

While write handlers can be used to specialize the object transfer, some aspects of it cannot be modified:

Transferring null will always result in null on the other endpoint.
Transferring a remote object will result in the corresponding local instance on the other endpoint.
Primitive types, boxed primitives, and String instances are transferred as-is.
Primitive arrays are transferred as-is.
Void is always transferred as null.
If transfer configuration was defined for the transferred object class then the write handler for that configuration is used to override the transfer.

This interface should not be directly implemented by users but users should use and extend already implemented versions of this interface in this package.

ObjectWriterKind

RMIWriter

Methods

public static RMIObjectWriteHandler	array(RMIObjectWriteHandler componenthandler) Utility method for constructing ArrayComponentRMIObjectWriteHandler.
public static RMIObjectWriteHandler	defaultWriter() Gets a common instance for DefaultRMIObjectWriteHandler.
public static RMIObjectWriteHandler	enumWriter() Gets a common instance for EnumRMIObjectWriteHandler.
public boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
public ObjectWriterKind	getKind() Gets the kind of this object write handler.
public int	hashCode() Returns a hash code value for the object.
public static RMIObjectWriteHandler	remote() Gets a common instance for RemoteRMIObjectWriteHandler.
public static RMIObjectWriteHandler	remoteOnly() Gets a common instance for RemoteOnlyRMIObjectWriteHandler.
public static RMIObjectWriteHandler	serialize() Gets a common instance for SerializeRMIObjectWriteHandler.
public static RMIObjectWriteHandler	wrapper(Class<? extends RMIWrapper> wrapper) Utility method for constructing WrapperRMIObjectWriteHandler.

public static RMIObjectWriteHandler array(RMIObjectWriteHandler componenthandler) throws NullPointerException

Utility method for constructing ArrayComponentRMIObjectWriteHandler.

componenthandlerThe component write handler.

The resulting write handler.

NullPointerExceptionIf the argument is null.

public static RMIObjectWriteHandler defaultWriter()

Gets a common instance for DefaultRMIObjectWriteHandler.

The common instance.

public static RMIObjectWriteHandler enumWriter()

Gets a common instance for EnumRMIObjectWriteHandler.

The common instance.

public abstract boolean equals(Object obj)

Overridden from: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

objthe reference object with which to compare.

true if this object is the same as the obj argument; false otherwise.

Object.hashCode()

HashMap

public abstract ObjectWriterKind getKind()

Gets the kind of this object write handler.

The kind.

public abstract int hashCode()

Overridden from: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the Object.equals(Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

a hash code value for this object.

Object.equals(Object)

System.identityHashCode(Object)

public static RMIObjectWriteHandler remote()

Gets a common instance for RemoteRMIObjectWriteHandler.

The common instance.

public static RMIObjectWriteHandler remoteOnly()

Gets a common instance for RemoteOnlyRMIObjectWriteHandler.

The common instance.

public static RMIObjectWriteHandler serialize()

Gets a common instance for SerializeRMIObjectWriteHandler.

The common instance.

public static RMIObjectWriteHandler wrapper(Class<? extends RMIWrapper> wrapper) throws NullPointerException, IllegalArgumentException

Utility method for constructing WrapperRMIObjectWriteHandler.

wrapperThe wrapper class.

The resulting write handler.

NullPointerExceptionIf the argument is null.

IllegalArgumentExceptionIf the argument class is not a valid wrapper class. (If it is abstract, or enum.)