-This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
-Package
-
-
-
-Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:
-
Interfaces (italic)
Classes
Enums
Exceptions
Errors
Annotation Types
-
-
-Class/Interface
-
-
-
-Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
-
Class inheritance diagram
Direct Subclasses
All Known Subinterfaces
All Known Implementing Classes
Class/interface declaration
Class/interface description
-
-
Nested Class Summary
Field Summary
Constructor Summary
Method Summary
-
-
Field Detail
Constructor Detail
Method Detail
-Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
-
-
-Annotation Type
-
-
-
-Each annotation type has its own separate page with the following sections:
-
Annotation Type declaration
Annotation Type description
Required Element Summary
Optional Element Summary
Element Detail
-
-
-
-Enum
-
-
-
-Each enum has its own separate page with the following sections:
-
Enum declaration
Enum description
Enum Constant Summary
Enum Constant Detail
-
-
-Tree (Class Hierarchy)
-
-There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
-
When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
-
-
-Deprecated API
-
-The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
-
-Index
-
-The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
-
-Prev/Next
-These links take you to the next or previous class, interface, package, or related page.
-Frames/No Frames
-These links show and hide the HTML frames. All pages are available with or without frames.
-
-
-Serialized Form
-Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
-
Tells this peer that the source peer has successfully merged
- numberOfMergedOperations altogether coming from this peer
- into its operation sequence.
-
A very simple peer implementation for operational transformations that starts
- out with a provided initial state and then receives operations which it applies
- to its state.
After an operation has been locally applied and needs to be propagated
- to the peer for which this is the queue of unmerged operations, the operation
- must be appended to this queue.
-
-Use the contents of this package for so-called operational transformations.
-This can be used to synchronize the states of a number of clients with a single server.
-The synchronization is performed asynchronously. The construction of the transformation
-function guarantees to lead to eventual consistency across clients and server.
-Read more about the general background of the algorithm on which this is based
-here.
-
-
-
-To establish a server to which clients can connect, first decide how your state
-is encoded on which the operations will perform changes to transition from one
-state to the next. Then, design your operations class. The trickiest part comes next. You
-have to define a transformer that maps a pair of your operations to another pair of
-operations of the same type. The transformer has to implement the
-{@link com.sap.runlet.operationaltransformation.Transformer} interface, in particular
-the {@link com.sap.runlet.operationaltransformation.Transformer#transform} method. The
-transformation function assumes that both input operations have been applied to the same
-state, one on a client, the other one on the server. The resulting operation for the client
-applied on the client must lead to a state equal to the state reached on the server by
-applying the resulting operation for the server to the server's state.
-
-
-
-Put formally, if t is a transformer, and
-if we have s_c as the state on the client and s_s as the state
-on the server, and c as the operation that was executed in state s_c on the
-client, and s as the operation executed on the server in state s_s, then the
-following condition must hold:
-
-You can create servers and clients, e.g., as follows:
-
- server = new {@link com.sap.runlet.operationaltransformation.PeerImpl PeerImpl}(
- "Server", new MyTransformer(), /* initial state */ new MyStateType(...), /* server */ true);
- client1 = new {@link com.sap.runlet.operationaltransformation.PeerImpl PeerImpl}("Client1", new MyTransformer(), server);
- client2 = new {@link com.sap.runlet.operationaltransformation.PeerImpl PeerImpl}("Client2", new MyTransformer(), server);
-
-
-After that, you can start sending operations to the clients using the
-{@link com.sap.runlet.operationaltransformation.Peer#apply} method as follows:
-
-and those changes will eventually get synchronized across all clients and the server. You can
-obtain the current state of a peer using the {@link com.sap.runlet.operationaltransformation.Peer#getCurrentState}
-operation.
-
-
-
\ No newline at end of file
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/AbstractOperation.java b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/AbstractOperation.java
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/AbstractOperation.java
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/AbstractOperation.java
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/ClientServerOperationPair.java b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/ClientServerOperationPair.java
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/ClientServerOperationPair.java
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/ClientServerOperationPair.java
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/Operation.java b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/Operation.java
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/Operation.java
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/Operation.java
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/Peer.java b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/Peer.java
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/Peer.java
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/Peer.java
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/PeerImpl.java b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/PeerImpl.java
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/PeerImpl.java
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/PeerImpl.java
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/StatesAndOperations.java b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/StatesAndOperations.java
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/StatesAndOperations.java
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/StatesAndOperations.java
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/Transformer.java b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/Transformer.java
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/Transformer.java
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/Transformer.java
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/UnmergedOperationsQueue.java b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/UnmergedOperationsQueue.java
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/UnmergedOperationsQueue.java
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/UnmergedOperationsQueue.java
diff --git a/java/com.sap.sailing.operationaltransformation/bin/com/sap/runlet/operationaltransformation/package.html b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/package.html
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/bin/com/sap/runlet/operationaltransformation/package.html
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/package.html
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/test/util/.svn/all-wcprops b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/test/util/.svn/all-wcprops
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/test/util/.svn/all-wcprops
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/test/util/.svn/all-wcprops
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/test/util/.svn/entries b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/test/util/.svn/entries
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/test/util/.svn/entries
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/test/util/.svn/entries
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/test/util/.svn/prop-base/Base64.java.svn-base b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/test/util/.svn/prop-base/Base64.java.svn-base
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/test/util/.svn/prop-base/Base64.java.svn-base
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/test/util/.svn/prop-base/Base64.java.svn-base
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/test/util/.svn/text-base/Base64.java.svn-base b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/test/util/.svn/text-base/Base64.java.svn-base
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/test/util/.svn/text-base/Base64.java.svn-base
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/test/util/.svn/text-base/Base64.java.svn-base
diff --git a/java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/test/util/Base64.java b/java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/test/util/Base64.java
similarity index 100%
rename from java/com.sap.sailing.operationaltransformation/src/com/sap/runlet/operationaltransformation/test/util/Base64.java
rename to java/com.sap.sailing.operationaltransformation/src/com/sap/sailing/operationaltransformation/test/util/Base64.java