From f22dbc4c3cb72a4fb9c40870c4ccee94265ee068 Mon Sep 17 00:00:00 2001
From: hvanwelbergen <hvanwelbergen@patty.TechFak.Uni-Bielefeld.DE>
Date: Thu, 26 Apr 2012 10:09:48 +0200
Subject: [PATCH] added some javadoc
---
java/src/ipaaca/IUPublishedException.java | 33 ++++++++-----
java/src/ipaaca/IUReadOnlyException.java | 33 ++++++++-----
java/src/ipaaca/IUStore.java | 11 ++++-
java/src/ipaaca/IUUpdateFailedException.java | 33 ++++++++-----
java/src/ipaaca/Initializer.java | 51 ++++++++------------
java/src/ipaaca/IntConverter.java | 5 ++
java/src/ipaaca/LinkUpdateConverter.java | 5 ++
java/src/ipaaca/PayloadConverter.java | 5 ++
java/src/ipaacademo/PythonCall.java | 5 ++
java/test/src/ipaaca/InputBufferTest.java | 5 ++
java/test/src/ipaaca/IuConverterTest.java | 5 ++
java/test/src/ipaaca/LocalIUTest.java | 5 +-
12 files changed, 124 insertions(+), 72 deletions(-)
diff --git a/java/src/ipaaca/IUPublishedException.java b/java/src/ipaaca/IUPublishedException.java
index 0431e1d..d94d5dd 100644
--- a/java/src/ipaaca/IUPublishedException.java
+++ b/java/src/ipaaca/IUPublishedException.java
@@ -1,17 +1,24 @@
package ipaaca;
-public class IUPublishedException extends RuntimeException{
- private static final long serialVersionUID = 1L;
- private final AbstractIU iu;
-
- public AbstractIU getIU() {
- return iu;
- }
-
- public IUPublishedException(AbstractIU iu)
- {
- super("IU " + iu.getUid() + " is already present in the output buffer.");
- this.iu = iu;
- }
+/**
+ * IUPublishedException exceptions occur when publishing (=putting it in an output buffer) an already published IU.
+ * @author hvanwelbergen
+ *
+ */
+public class IUPublishedException extends RuntimeException
+{
+ private static final long serialVersionUID = 1L;
+ private final AbstractIU iu;
+
+ public AbstractIU getIU()
+ {
+ return iu;
+ }
+
+ public IUPublishedException(AbstractIU iu)
+ {
+ super("IU " + iu.getUid() + " is already present in the output buffer.");
+ this.iu = iu;
+ }
}
diff --git a/java/src/ipaaca/IUReadOnlyException.java b/java/src/ipaaca/IUReadOnlyException.java
index 59bf6a2..cc7b935 100644
--- a/java/src/ipaaca/IUReadOnlyException.java
+++ b/java/src/ipaaca/IUReadOnlyException.java
@@ -1,16 +1,23 @@
package ipaaca;
-public class IUReadOnlyException extends RuntimeException{
- private static final long serialVersionUID = 1L;
- private final AbstractIU iu;
-
- public AbstractIU getIU() {
- return iu;
- }
-
- public IUReadOnlyException(AbstractIU iu)
- {
- super("Writing to IU " + iu.getUid() + " failed -- it is read-only.");
- this.iu = iu;
- }
+/**
+ * IUReadOnlyException's occur when writing to a read-only IU
+ * @author hvanwelbergen
+ *
+ */
+public class IUReadOnlyException extends RuntimeException
+{
+ private static final long serialVersionUID = 1L;
+ private final AbstractIU iu;
+
+ public AbstractIU getIU()
+ {
+ return iu;
+ }
+
+ public IUReadOnlyException(AbstractIU iu)
+ {
+ super("Writing to IU " + iu.getUid() + " failed -- it is read-only.");
+ this.iu = iu;
+ }
}
diff --git a/java/src/ipaaca/IUStore.java b/java/src/ipaaca/IUStore.java
index 96b6d65..170b283 100644
--- a/java/src/ipaaca/IUStore.java
+++ b/java/src/ipaaca/IUStore.java
@@ -1,7 +1,14 @@
package ipaaca;
-import java.util.HashMap;
+import java.util.HashMap;
-public class IUStore<X extends AbstractIU> extends HashMap<String,X>{
+/**
+ * An IUStore maps an IUid to an IU
+ * @author hvanwelbergen
+ *
+ * @param <X> type of AbstractIU stored in the store
+ */
+public class IUStore<X extends AbstractIU> extends HashMap<String, X>
+{
private static final long serialVersionUID = 1L;
}
diff --git a/java/src/ipaaca/IUUpdateFailedException.java b/java/src/ipaaca/IUUpdateFailedException.java
index e06c1d9..e2b9b17 100644
--- a/java/src/ipaaca/IUUpdateFailedException.java
+++ b/java/src/ipaaca/IUUpdateFailedException.java
@@ -1,16 +1,23 @@
package ipaaca;
-public class IUUpdateFailedException extends RuntimeException{
- private static final long serialVersionUID = 1L;
- private final AbstractIU iu;
-
- public AbstractIU getIU() {
- return iu;
- }
-
- public IUUpdateFailedException(AbstractIU iu)
- {
- super("Remote update failed for IU " + iu.getUid() + ".");
- this.iu = iu;
- }
+/**
+ * Indicates that a remote update failed
+ * @author hvanwelbergen
+ *
+ */
+public class IUUpdateFailedException extends RuntimeException
+{
+ private static final long serialVersionUID = 1L;
+ private final AbstractIU iu;
+
+ public AbstractIU getIU()
+ {
+ return iu;
+ }
+
+ public IUUpdateFailedException(AbstractIU iu)
+ {
+ super("Remote update failed for IU " + iu.getUid() + ".");
+ this.iu = iu;
+ }
}
diff --git a/java/src/ipaaca/Initializer.java b/java/src/ipaaca/Initializer.java
index 331bdcc..0695993 100644
--- a/java/src/ipaaca/Initializer.java
+++ b/java/src/ipaaca/Initializer.java
@@ -5,35 +5,26 @@ import rsb.converter.ConverterSignature;
import rsb.converter.DefaultConverterRepository;
import rsb.converter.ProtocolBufferConverter;
-public final class Initializer {
-// def initialize_ipaaca_rsb():#{{{
-// rsb.transport.converter.registerGlobalConverter(
-// IntConverter(wireSchema="int32", dataType=int))
-// rsb.transport.converter.registerGlobalConverter(
-// IUConverter(wireSchema="ipaaca-iu", dataType=IU))
-// rsb.transport.converter.registerGlobalConverter(
-// IUPayloadUpdateConverter(
-// wireSchema="ipaaca-iu-payload-update",
-// dataType=IUPayloadUpdate))
-// rsb.transport.converter.registerGlobalConverter(
-// rsb.transport.converter.ProtocolBufferConverter(
-// messageClass=iuProtoBuf_pb2.IUCommission))
-// rsb.__defaultParticipantConfig = rsb.ParticipantConfig.fromDefaultSources()
-// #}}}
- public static void initializeIpaacaRsb()
- {
- DefaultConverterRepository.getDefaultConverterRepository().addConverter(new IntConverter());
- DefaultConverterRepository.getDefaultConverterRepository()
- .addConverter(new ProtocolBufferConverter<IUCommission>(IUCommission.getDefaultInstance()));
-
- DefaultConverterRepository.getDefaultConverterRepository().addConverter(
- new IUConverter(new ConverterSignature("ipaaca-iu", RemotePushIU.class)));
- DefaultConverterRepository.getDefaultConverterRepository().addConverter(
+/**
+ * Hooks up the ipaaca converters, call initializeIpaacaRsb() before using ipaaca.
+ * @author hvanwelbergen
+ *
+ */
+public final class Initializer
+{
+ private Initializer(){}
+ public static void initializeIpaacaRsb()
+ {
+ DefaultConverterRepository.getDefaultConverterRepository().addConverter(new IntConverter());
+ DefaultConverterRepository.getDefaultConverterRepository().addConverter(
+ new ProtocolBufferConverter<IUCommission>(IUCommission.getDefaultInstance()));
+
+ DefaultConverterRepository.getDefaultConverterRepository().addConverter(
+ new IUConverter(new ConverterSignature("ipaaca-iu", RemotePushIU.class)));
+ DefaultConverterRepository.getDefaultConverterRepository().addConverter(
new IUConverter(new ConverterSignature("ipaaca-localiu", LocalIU.class)));
- DefaultConverterRepository.getDefaultConverterRepository().addConverter(
- new PayloadConverter());
- DefaultConverterRepository.getDefaultConverterRepository().addConverter(
- new LinkUpdateConverter());
-
- }
+ DefaultConverterRepository.getDefaultConverterRepository().addConverter(new PayloadConverter());
+ DefaultConverterRepository.getDefaultConverterRepository().addConverter(new LinkUpdateConverter());
+
+ }
}
diff --git a/java/src/ipaaca/IntConverter.java b/java/src/ipaaca/IntConverter.java
index 2c7fba3..1327b10 100644
--- a/java/src/ipaaca/IntConverter.java
+++ b/java/src/ipaaca/IntConverter.java
@@ -11,6 +11,11 @@ import rsb.converter.WireContents;
import com.google.protobuf.InvalidProtocolBufferException;
+/**
+ * Serializer/deserializer for ints
+ * @author hvanwelbergen
+ *
+ */
public class IntConverter implements Converter<ByteBuffer>
{
diff --git a/java/src/ipaaca/LinkUpdateConverter.java b/java/src/ipaaca/LinkUpdateConverter.java
index db85edb..a61e0e4 100644
--- a/java/src/ipaaca/LinkUpdateConverter.java
+++ b/java/src/ipaaca/LinkUpdateConverter.java
@@ -12,6 +12,11 @@ import rsb.converter.WireContents;
import com.google.protobuf.InvalidProtocolBufferException;
+/**
+ * Serializer/deserializer for IULinkUpdate
+ * @author hvanwelbergen
+ *
+ */
public class LinkUpdateConverter implements Converter<ByteBuffer>
{
private static final String LINKUPDATE_WIRESCHEMA = "ipaaca-iu-link-update";
diff --git a/java/src/ipaaca/PayloadConverter.java b/java/src/ipaaca/PayloadConverter.java
index a95e711..c78546c 100644
--- a/java/src/ipaaca/PayloadConverter.java
+++ b/java/src/ipaaca/PayloadConverter.java
@@ -12,6 +12,11 @@ import rsb.converter.WireContents;
import com.google.protobuf.InvalidProtocolBufferException;
+/**
+ * Serializer/deserializer for IUPayloadUpdate
+ * @author hvanwelbergen
+ *
+ */
public class PayloadConverter implements Converter<ByteBuffer>
{
private static final String PAYLOAD_WIRESCHEMA = "ipaaca-iu-payload-update";
diff --git a/java/src/ipaacademo/PythonCall.java b/java/src/ipaacademo/PythonCall.java
index 09c7093..6aca5d7 100644
--- a/java/src/ipaacademo/PythonCall.java
+++ b/java/src/ipaacademo/PythonCall.java
@@ -6,6 +6,11 @@ import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
+/**
+ * Demonstrates how to call a python script from java
+ * @author hvanwelbergen
+ *
+ */
public class PythonCall
{
diff --git a/java/test/src/ipaaca/InputBufferTest.java b/java/test/src/ipaaca/InputBufferTest.java
index ad12fc6..aa63e98 100644
--- a/java/test/src/ipaaca/InputBufferTest.java
+++ b/java/test/src/ipaaca/InputBufferTest.java
@@ -14,6 +14,11 @@ import rsb.RSBException;
import com.google.common.collect.ImmutableSet;
+/**
+ * Unit testcases for the input buffer
+ * @author hvanwelbergen
+ *
+ */
public class InputBufferTest
{
private static final String COMPID = "Comp1";
diff --git a/java/test/src/ipaaca/IuConverterTest.java b/java/test/src/ipaaca/IuConverterTest.java
index d1b558f..4d1fac8 100644
--- a/java/test/src/ipaaca/IuConverterTest.java
+++ b/java/test/src/ipaaca/IuConverterTest.java
@@ -27,6 +27,11 @@ import rsb.converter.WireContents;
import rsb.patterns.RemoteServer;
import static ipaaca.IUTestUtil.*;
+/**
+ * Unit test cases for the IUConverter
+ * @author hvanwelbergen
+ *
+ */
public class IuConverterTest
{
private static final String CATEGORY = "category1";
diff --git a/java/test/src/ipaaca/LocalIUTest.java b/java/test/src/ipaaca/LocalIUTest.java
index f131997..797859b 100644
--- a/java/test/src/ipaaca/LocalIUTest.java
+++ b/java/test/src/ipaaca/LocalIUTest.java
@@ -6,7 +6,10 @@ import ipaaca.protobuf.Ipaaca.IUPayloadUpdate;
import org.junit.Before;
import org.junit.Test;
import static org.mockito.Mockito.*;
-
+/**
+ * Unit testcases for the LocalIU
+ * @author hvanwelbergen
+ */
public class LocalIUTest
{
OutputBuffer mockBuffer = mock(OutputBuffer.class);
--
GitLab