http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServerImpl.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServerImpl.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServerImpl.java index 77c012a..a18bcd8 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServerImpl.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameServerImpl.java @@ -48,7 +48,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Naming server implementation + * Naming server implementation. */ public class NameServerImpl implements NameServer { @@ -117,7 +117,7 @@ public class NameServerImpl implements NameServer { } /** - * Constructs a name server + * Constructs a name server. * * @param port a listening port number * @param factory an identifier factory @@ -136,7 +136,7 @@ public class NameServerImpl implements NameServer { /** - * Constructs a name server + * Constructs a name server. * * @param port a listening port number * @param factory an identifier factory @@ -184,7 +184,7 @@ public class NameServerImpl implements NameServer { return handler; } /** - * Gets port + * Gets port. */ @Override public int getPort() { @@ -192,7 +192,7 @@ public class NameServerImpl implements NameServer { } /** - * Closes resources + * Closes resources. */ @Override public void close() throws Exception { @@ -200,7 +200,7 @@ public class NameServerImpl implements NameServer { } /** - * Registers an (identifier, address) mapping locally + * Registers an (identifier, address) mapping locally. * * @param id an identifier * @param addr an Internet socket address @@ -212,7 +212,7 @@ public class NameServerImpl implements NameServer { } /** - * Unregisters an identifier locally + * Unregisters an identifier locally. * * @param id an identifier */ @@ -223,7 +223,7 @@ public class NameServerImpl implements NameServer { } /** - * Finds an address for an identifier locally + * Finds an address for an identifier locally. * * @param id an identifier * @return an Internet socket address @@ -235,7 +235,7 @@ public class NameServerImpl implements NameServer { } /** - * Finds addresses for identifiers locally + * Finds addresses for identifiers locally. * * @param identifiers an iterable of identifiers * @return a list of name assignments @@ -260,7 +260,7 @@ public class NameServerImpl implements NameServer { } /** - * Naming server transport event handler that invokes a specific naming message handler + * Naming server transport event handler that invokes a specific naming message handler. */ class NamingServerHandler implements EventHandler<TransportEvent> { @@ -282,7 +282,7 @@ class NamingServerHandler implements EventHandler<TransportEvent> { } /** - * Naming lookup request handler + * Naming lookup request handler. */ class NamingLookupRequestHandler implements EventHandler<NamingLookupRequest> { @@ -306,7 +306,7 @@ class NamingLookupRequestHandler implements EventHandler<NamingLookupRequest> { } /** - * Naming register request handler + * Naming register request handler. */ class NamingRegisterRequestHandler implements EventHandler<NamingRegisterRequest> { @@ -330,7 +330,7 @@ class NamingRegisterRequestHandler implements EventHandler<NamingRegisterRequest } /** - * Naming unregister request handler + * Naming unregister request handler. */ class NamingUnregisterRequestHandler implements EventHandler<NamingUnregisterRequest> { @@ -344,4 +344,4 @@ class NamingUnregisterRequestHandler implements EventHandler<NamingUnregisterReq public void onNext(final NamingUnregisterRequest value) { server.unregister(value.getIdentifier()); } -} \ No newline at end of file +}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NamingCodecFactory.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NamingCodecFactory.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NamingCodecFactory.java index 8ec320a..dc0fa62 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NamingCodecFactory.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NamingCodecFactory.java @@ -27,12 +27,12 @@ import java.util.HashMap; import java.util.Map; /** - * Factory to create naming codecs + * Factory to create naming codecs. */ class NamingCodecFactory { /** - * Creates a codec only for lookup + * Creates a codec only for lookup. * * @param factory an identifier factory * @return a codec @@ -47,7 +47,7 @@ class NamingCodecFactory { } /** - * Creates a codec only for registration + * Creates a codec only for registration. * * @param factory an identifier factory * @return a codec @@ -63,7 +63,7 @@ class NamingCodecFactory { } /** - * Creates a codec for both lookup and registration + * Creates a codec for both lookup and registration. * * @param factory an identifier factory * @return a codec http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/NamingException.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/NamingException.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/NamingException.java index b5093b4..6129c1b 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/NamingException.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/NamingException.java @@ -21,13 +21,13 @@ package org.apache.reef.io.network.naming.exception; import org.apache.reef.exception.evaluator.NetworkException; /** - * Naming exception + * Naming exception. */ public class NamingException extends NetworkException { private static final long serialVersionUID = 1L; /** - * Constructs a new resourcemanager naming exception with the specified detail message and cause + * Constructs a new resourcemanager naming exception with the specified detail message and cause. * * @param s the detailed message * @param e the cause @@ -37,7 +37,7 @@ public class NamingException extends NetworkException { } /** - * Constructs a new resourcemanager naming exception with the specified detail message + * Constructs a new resourcemanager naming exception with the specified detail message. * * @param s the detailed message */ @@ -46,7 +46,7 @@ public class NamingException extends NetworkException { } /** - * Constructs a new resourcemanager naming exception with the specified cause + * Constructs a new resourcemanager naming exception with the specified cause. * * @param e the cause */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/NamingRuntimeException.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/NamingRuntimeException.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/NamingRuntimeException.java index 9ed0f49..3fe11d9 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/NamingRuntimeException.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/NamingRuntimeException.java @@ -21,13 +21,13 @@ package org.apache.reef.io.network.naming.exception; import org.apache.reef.io.network.exception.NetworkRuntimeException; /** - * Naming resourcemanager exception + * Naming resourcemanager exception. */ public class NamingRuntimeException extends NetworkRuntimeException { private static final long serialVersionUID = 1L; /** - * Constructs a new resourcemanager naming exception with the specified detail message and cause + * Constructs a new resourcemanager naming exception with the specified detail message and cause. * * @param s the detailed message * @param e the cause @@ -37,7 +37,7 @@ public class NamingRuntimeException extends NetworkRuntimeException { } /** - * Constructs a new resourcemanager naming exception with the specified detail message + * Constructs a new resourcemanager naming exception with the specified detail message. * * @param s the detailed message */ @@ -46,7 +46,7 @@ public class NamingRuntimeException extends NetworkRuntimeException { } /** - * Constructs a new resourcemanager naming exception with the specified cause + * Constructs a new resourcemanager naming exception with the specified cause. * * @param e the cause */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/AvroUtils.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/AvroUtils.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/AvroUtils.java index 73a1cd4..b47e200 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/AvroUtils.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/AvroUtils.java @@ -34,7 +34,7 @@ final class AvroUtils { } /** - * Serializes the given avro object to a byte[] + * Serializes the given avro object to a byte[]. * * @param avroObject * @param theClass http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupRequest.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupRequest.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupRequest.java index eda5f15..beda76a 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupRequest.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupRequest.java @@ -21,13 +21,13 @@ package org.apache.reef.io.network.naming.serialization; import org.apache.reef.wake.Identifier; /** - * Naming lookup request + * Naming lookup request. */ public class NamingLookupRequest extends NamingMessage { private Iterable<Identifier> ids; /** - * Constructs a naming lookup request + * Constructs a naming lookup request. * * @param ids the iterable of identifiers */ @@ -36,7 +36,7 @@ public class NamingLookupRequest extends NamingMessage { } /** - * Gets identifiers + * Gets identifiers. * * @return an iterable of identifiers */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupRequestCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupRequestCodec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupRequestCodec.java index b388ba6..8b05269 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupRequestCodec.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupRequestCodec.java @@ -28,14 +28,14 @@ import java.util.ArrayList; import java.util.List; /** - * Naming lookup request codec + * Naming lookup request codec. */ public final class NamingLookupRequestCodec implements Codec<NamingLookupRequest> { private final IdentifierFactory factory; /** - * Constructs a naming lookup request codec + * Constructs a naming lookup request codec. * * @param factory the identifier factory */ @@ -45,7 +45,7 @@ public final class NamingLookupRequestCodec implements Codec<NamingLookupRequest } /** - * Encodes the identifiers to bytes + * Encodes the identifiers to bytes. * * @param obj the naming lookup request * @return a byte array @@ -60,7 +60,7 @@ public final class NamingLookupRequestCodec implements Codec<NamingLookupRequest } /** - * Decodes the bytes to a naming lookup request + * Decodes the bytes to a naming lookup request. * * @param buf the byte array * @return a naming lookup request http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupResponse.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupResponse.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupResponse.java index 822f170..0f55851 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupResponse.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupResponse.java @@ -23,13 +23,13 @@ import org.apache.reef.io.naming.NameAssignment; import java.util.List; /** - * Naming lookup response + * Naming lookup response. */ public class NamingLookupResponse extends NamingMessage { private final List<NameAssignment> nas; /** - * Constructs a naming lookup response + * Constructs a naming lookup response. * * @param nas the list of name assignments */ @@ -38,7 +38,7 @@ public class NamingLookupResponse extends NamingMessage { } /** - * Gets name assignments + * Gets name assignments. * * @return a list of name assignments */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupResponseCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupResponseCodec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupResponseCodec.java index affe3b6..aba3d9c 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupResponseCodec.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingLookupResponseCodec.java @@ -32,14 +32,14 @@ import java.util.ArrayList; import java.util.List; /** - * Naming lookup response codec + * Naming lookup response codec. */ public final class NamingLookupResponseCodec implements Codec<NamingLookupResponse> { private final IdentifierFactory factory; /** - * Constructs a naming lookup response codec + * Constructs a naming lookup response codec. * * @param factory the identifier factory */ @@ -49,7 +49,7 @@ public final class NamingLookupResponseCodec implements Codec<NamingLookupRespon } /** - * Encodes name assignments to bytes + * Encodes name assignments to bytes. * * @param obj the naming lookup response * @return a byte array @@ -70,7 +70,7 @@ public final class NamingLookupResponseCodec implements Codec<NamingLookupRespon } /** - * Decodes bytes to an iterable of name assignments + * Decodes bytes to an iterable of name assignments. * * @param buf the byte array * @return a naming lookup response http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingMessage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingMessage.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingMessage.java index 3152854..d3f3abe 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingMessage.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingMessage.java @@ -21,13 +21,13 @@ package org.apache.reef.io.network.naming.serialization; import org.apache.reef.wake.remote.transport.Link; /** - * An abstract base class for naming messages + * An abstract base class for naming messages. */ public abstract class NamingMessage { private transient Link<byte[]> link; /** - * Gets a link + * Gets a link. * * @return a link */ @@ -36,7 +36,7 @@ public abstract class NamingMessage { } /** - * Sets the link + * Sets the link. * * @param link the link */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterRequest.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterRequest.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterRequest.java index e6e1e9c..f458efc 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterRequest.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterRequest.java @@ -21,13 +21,13 @@ package org.apache.reef.io.network.naming.serialization; import org.apache.reef.io.naming.NameAssignment; /** - * naming registration request + * naming registration request. */ public class NamingRegisterRequest extends NamingMessage { private final NameAssignment na; /** - * Constructs a naming registration request + * Constructs a naming registration request. * * @param na the name assignment */ @@ -36,7 +36,7 @@ public class NamingRegisterRequest extends NamingMessage { } /** - * Gets a name assignment + * Gets a name assignment. * * @return a name assignment */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterRequestCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterRequestCodec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterRequestCodec.java index c32d888..d1d284f 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterRequestCodec.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterRequestCodec.java @@ -27,14 +27,14 @@ import org.apache.reef.wake.remote.Codec; import java.net.InetSocketAddress; /** - * Naming registration request codec + * Naming registration request codec. */ public class NamingRegisterRequestCodec implements Codec<NamingRegisterRequest> { private final IdentifierFactory factory; /** - * Constructs a naming registration request codec + * Constructs a naming registration request codec. * * @param factory the identifier factory */ @@ -43,7 +43,7 @@ public class NamingRegisterRequestCodec implements Codec<NamingRegisterRequest> } /** - * Encodes the name assignment to bytes + * Encodes the name assignment to bytes. * * @param obj the naming registration request * @return a byte array @@ -59,7 +59,7 @@ public class NamingRegisterRequestCodec implements Codec<NamingRegisterRequest> } /** - * Decodes the bytes to a name assignment + * Decodes the bytes to a name assignment. * * @param buf the byte array * @return a naming registration request @@ -73,4 +73,4 @@ public class NamingRegisterRequestCodec implements Codec<NamingRegisterRequest> new InetSocketAddress(avroNamingRegisterRequest.getHost().toString(), avroNamingRegisterRequest.getPort())) ); } -} \ No newline at end of file +} http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterResponse.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterResponse.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterResponse.java index b8c416f..b0f40c1 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterResponse.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterResponse.java @@ -19,13 +19,13 @@ package org.apache.reef.io.network.naming.serialization; /** - * naming registration response + * naming registration response. */ public class NamingRegisterResponse extends NamingMessage { private final NamingRegisterRequest request; /** - * Constructs a naming register response + * Constructs a naming register response. * * @param request the naming register request */ @@ -34,7 +34,7 @@ public class NamingRegisterResponse extends NamingMessage { } /** - * Gets a naming register request + * Gets a naming register request. * * @return a naming register request */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterResponseCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterResponseCodec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterResponseCodec.java index f95a90e..88290bc 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterResponseCodec.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingRegisterResponseCodec.java @@ -21,13 +21,13 @@ package org.apache.reef.io.network.naming.serialization; import org.apache.reef.wake.remote.Codec; /** - * naming registration response codec + * naming registration response codec. */ public class NamingRegisterResponseCodec implements Codec<NamingRegisterResponse> { private final NamingRegisterRequestCodec codec; /** - * Constructs a naming register response codec + * Constructs a naming register response codec. * * @param codec the naming register request codec */ @@ -36,7 +36,7 @@ public class NamingRegisterResponseCodec implements Codec<NamingRegisterResponse } /** - * Encodes a naming register response to bytes + * Encodes a naming register response to bytes. * * @param obj the naming register response * @return bytes a byte array @@ -47,7 +47,7 @@ public class NamingRegisterResponseCodec implements Codec<NamingRegisterResponse } /** - * Decodes a naming register response from the bytes + * Decodes a naming register response from the bytes. * * @param buf the byte array * @return a naming register response http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingUnregisterRequest.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingUnregisterRequest.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingUnregisterRequest.java index 770b7c9..1bf581e 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingUnregisterRequest.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingUnregisterRequest.java @@ -21,13 +21,13 @@ package org.apache.reef.io.network.naming.serialization; import org.apache.reef.wake.Identifier; /** - * Naming un-registration request + * Naming un-registration request. */ public class NamingUnregisterRequest extends NamingMessage { private final Identifier id; /** - * Constructs a naming un-registration request + * Constructs a naming un-registration request. * * @param id the identifier */ @@ -36,7 +36,7 @@ public class NamingUnregisterRequest extends NamingMessage { } /** - * Gets an identifier + * Gets an identifier. * * @return an identifier */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingUnregisterRequestCodec.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingUnregisterRequestCodec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingUnregisterRequestCodec.java index ea505c3..31ee934 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingUnregisterRequestCodec.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/NamingUnregisterRequestCodec.java @@ -26,14 +26,14 @@ import org.apache.reef.wake.remote.Codec; import javax.inject.Inject; /** - * Naming un-registration request codec + * Naming un-registration request codec. */ public final class NamingUnregisterRequestCodec implements Codec<NamingUnregisterRequest> { private final IdentifierFactory factory; /** - * Constructs a naming un-registration request codec + * Constructs a naming un-registration request codec. * * @param factory the identifier factory */ @@ -43,7 +43,7 @@ public final class NamingUnregisterRequestCodec implements Codec<NamingUnregiste } /** - * Encodes the naming un-registration request to bytes + * Encodes the naming un-registration request to bytes. * * @param obj the naming un-registration request * @return a byte array @@ -57,7 +57,7 @@ public final class NamingUnregisterRequestCodec implements Codec<NamingUnregiste } /** - * Decodes the bytes to a naming un-registration request + * Decodes the bytes to a naming un-registration request. * * @param buf the byte array * @return a naming un-registration request http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/package-info.java index d4ff9d3..a15dc8a 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/package-info.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/serialization/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * Contains naming serialization codecs + * Contains naming serialization codecs. */ -package org.apache.reef.io.network.naming.serialization; \ No newline at end of file +package org.apache.reef.io.network.naming.serialization; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/StringIdentifier.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/StringIdentifier.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/StringIdentifier.java index 5d6454b..1fcb0bd 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/StringIdentifier.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/StringIdentifier.java @@ -22,14 +22,14 @@ import org.apache.reef.wake.ComparableIdentifier; import org.apache.reef.wake.Identifier; /** - * String identifier + * String identifier. */ public class StringIdentifier implements ComparableIdentifier { private final String str; /** - * Constructs a string identifier + * Constructs a string identifier. * * @param str a string */ @@ -38,7 +38,7 @@ public class StringIdentifier implements ComparableIdentifier { } /** - * Returns a hash code for the object + * Returns a hash code for the object. * * @return a hash code value for this object */ @@ -47,7 +47,7 @@ public class StringIdentifier implements ComparableIdentifier { } /** - * Checks that another object is equal to this object + * Checks that another object is equal to this object. * * @param o another object * @return true if the object is the same as the object argument; false, otherwise @@ -57,7 +57,7 @@ public class StringIdentifier implements ComparableIdentifier { } /** - * Returns a string representation of the object + * Returns a string representation of the object. * * @return a string representation of the object */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/StringIdentifierFactory.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/StringIdentifierFactory.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/StringIdentifierFactory.java index 9886a01..6375087 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/StringIdentifierFactory.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/StringIdentifierFactory.java @@ -24,7 +24,7 @@ import org.apache.reef.wake.IdentifierFactory; import javax.inject.Inject; /** - * Factory that creates StringIdentifier + * Factory that creates StringIdentifier. */ public class StringIdentifierFactory implements IdentifierFactory { @@ -33,7 +33,7 @@ public class StringIdentifierFactory implements IdentifierFactory { } /** - * Creates a StringIdentifier object + * Creates a StringIdentifier object. * * @param s a string * @return a string identifier http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/local/LocalScratchSpace.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/local/LocalScratchSpace.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/local/LocalScratchSpace.java index 34f0f5c..5c34c71 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/local/LocalScratchSpace.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/local/LocalScratchSpace.java @@ -31,7 +31,7 @@ public class LocalScratchSpace implements ScratchSpace { private final String evaluatorName; private final Set<File> tempFiles = new ConcurrentSkipListSet<File>(); /** - * Zero denotes "unlimited" + * Zero denotes "unlimited". */ private long quota; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/HDInsightJVMPathProvider.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/HDInsightJVMPathProvider.java b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/HDInsightJVMPathProvider.java index d4ab0cc..ef91a8a 100644 --- a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/HDInsightJVMPathProvider.java +++ b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/HDInsightJVMPathProvider.java @@ -22,7 +22,7 @@ import com.google.inject.Inject; import org.apache.reef.runtime.common.files.RuntimePathProvider; /** - * Supplies the java binary's path for HDInsight + * Supplies the java binary's path for HDInsight. */ public final class HDInsightJVMPathProvider implements RuntimePathProvider { @Inject http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/HDICLI.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/HDICLI.java b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/HDICLI.java index 37631d7..77557d1 100644 --- a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/HDICLI.java +++ b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/HDICLI.java @@ -34,7 +34,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Main class for the HDInsight REST commandline + * Main class for the HDInsight REST commandline. */ public final class HDICLI { private static final Logger LOG = Logger.getLogger(HDICLI.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/LogFileEntry.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/LogFileEntry.java b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/LogFileEntry.java index 0b57b4c..a7322fa 100644 --- a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/LogFileEntry.java +++ b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/LogFileEntry.java @@ -36,7 +36,7 @@ final class LogFileEntry { } /** - * Writes the contents of the entry into the given outputWriter + * Writes the contents of the entry into the given outputWriter. * * @param outputWriter * @throws IOException http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/TFileParser.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/TFileParser.java b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/TFileParser.java index f343faf..fd205a0 100644 --- a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/TFileParser.java +++ b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/TFileParser.java @@ -30,7 +30,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Parse TFile's content to key value pair + * Parse TFile's content to key value pair. */ final class TFileParser { private static final Logger LOG = Logger.getLogger(TFileParser.class.getName()); @@ -59,7 +59,7 @@ final class TFileParser { } /** - * Parses the given file and stores the logs for each container in a file named after the container in the given + * Parses the given file and stores the logs for each container in a file named after the container in the given. * outputFolder * * @param inputPath http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/package-info.java b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/package-info.java index 9bbe75e..367577c 100644 --- a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/package-info.java +++ b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/cli/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * A command line interface for HDInsight + * A command line interface for HDInsight. */ -package org.apache.reef.runtime.hdinsight.cli; \ No newline at end of file +package org.apache.reef.runtime.hdinsight.cli; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/HDInsightRuntimeConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/HDInsightRuntimeConfiguration.java b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/HDInsightRuntimeConfiguration.java index 2047360..17cc026 100644 --- a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/HDInsightRuntimeConfiguration.java +++ b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/HDInsightRuntimeConfiguration.java @@ -64,7 +64,7 @@ public final class HDInsightRuntimeConfiguration extends ConfigurationModuleBuil public static final RequiredParameter<String> PASSWORD = new RequiredParameter<>(); /** - * The environment variable that holds the path to the default configuration file + * The environment variable that holds the path to the default configuration file. */ public static final String HDINSIGHT_CONFIGURATION_FILE_ENVIRONMENT_VARIABLE = "REEF_HDI_CONF"; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/UnsafeHDInsightRuntimeConfigurationStatic.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/UnsafeHDInsightRuntimeConfigurationStatic.java b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/UnsafeHDInsightRuntimeConfigurationStatic.java index 0779a3a..e2b9943 100644 --- a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/UnsafeHDInsightRuntimeConfigurationStatic.java +++ b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/UnsafeHDInsightRuntimeConfigurationStatic.java @@ -34,7 +34,7 @@ import org.apache.reef.util.logging.LoggingSetup; import org.apache.reef.wake.remote.RemoteConfiguration; /** - * The static part of the UnsafeHDInsightRuntimeConfiguration + * The static part of the UnsafeHDInsightRuntimeConfiguration. */ public final class UnsafeHDInsightRuntimeConfigurationStatic extends ConfigurationModuleBuilder { static { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/DriverConfigurationProvider.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/DriverConfigurationProvider.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/DriverConfigurationProvider.java index e22a7d5..6e85ffc 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/DriverConfigurationProvider.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/DriverConfigurationProvider.java @@ -56,7 +56,7 @@ public final class DriverConfigurationProvider { } /** - * Assembles the driver configuration + * Assembles the driver configuration. * * @param jobFolder The folder in which the local runtime will execute this job. * @param clientRemoteId the remote identifier of the client. It is used by the Driver to establish a http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/PreparedDriverFolderLauncher.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/PreparedDriverFolderLauncher.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/PreparedDriverFolderLauncher.java index 602c04d..267edf0 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/PreparedDriverFolderLauncher.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/PreparedDriverFolderLauncher.java @@ -60,7 +60,7 @@ public class PreparedDriverFolderLauncher { } /** - * Launches the driver prepared in driverFolder + * Launches the driver prepared in driverFolder. * * @param driverFolder * @param jobId http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/package-info.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/package-info.java index 6665204..5cca3a1 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/package-info.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * client-side event handlers for the local resourcemanager + * client-side event handlers for the local resourcemanager. */ package org.apache.reef.runtime.local.client; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/parameters/MaxNumberOfEvaluators.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/parameters/MaxNumberOfEvaluators.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/parameters/MaxNumberOfEvaluators.java index 316a659..1bfee5c 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/parameters/MaxNumberOfEvaluators.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/parameters/MaxNumberOfEvaluators.java @@ -22,7 +22,7 @@ import org.apache.reef.tang.annotations.Name; import org.apache.reef.tang.annotations.NamedParameter; /** - * The maximum number of evaluators to allow to run at once + * The maximum number of evaluators to allow to run at once. */ @NamedParameter(default_value = "4", doc = "The maximum number of evaluators to allow to run at once", short_name = "maxEvaluators") public final class MaxNumberOfEvaluators implements Name<Integer> { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ContainerManager.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ContainerManager.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ContainerManager.java index 9127da9..918e1d1 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ContainerManager.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ContainerManager.java @@ -58,12 +58,12 @@ final class ContainerManager implements AutoCloseable { private final static Logger LOG = Logger.getLogger(ContainerManager.class.getName()); /** - * Map from containerID -> Container + * Map from containerID -> Container. */ private final Map<String, Container> containers = new HashMap<>(); /** - * List of free, unallocated nodes by their Node ID + * List of free, unallocated nodes by their Node ID. */ private final List<String> freeNodeList = new LinkedList<>(); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalDriverConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalDriverConfiguration.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalDriverConfiguration.java index 1db7503..9fb4444 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalDriverConfiguration.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalDriverConfiguration.java @@ -51,7 +51,7 @@ public class LocalDriverConfiguration extends ConfigurationModuleBuilder { public static final OptionalParameter<Double> JVM_HEAP_SLACK = new OptionalParameter<>(); /** - * The remote identifier to use for communications back to the client + * The remote identifier to use for communications back to the client. */ public static final OptionalParameter<String> CLIENT_REMOTE_IDENTIFIER = new OptionalParameter<>(); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalResourceRequestHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalResourceRequestHandler.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalResourceRequestHandler.java index 99ae748..db268a5 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalResourceRequestHandler.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalResourceRequestHandler.java @@ -26,7 +26,7 @@ import org.apache.reef.runtime.common.driver.api.ResourceRequestHandler; import javax.inject.Inject; /** - * Takes resource requests and patches them through to the ResourceManager + * Takes resource requests and patches them through to the ResourceManager. */ @Private @DriverSide http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ProcessContainer.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ProcessContainer.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ProcessContainer.java index 2497ed7..d6e23b2 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ProcessContainer.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ProcessContainer.java @@ -35,7 +35,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * A Container that runs an Evaluator in a Process + * A Container that runs an Evaluator in a Process. */ @Private @TaskSide http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/package-info.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/package-info.java index d79462d..98310b6 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/package-info.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * The resource manager for the local resourcemanager + * The resource manager for the local resourcemanager. */ package org.apache.reef.runtime.local.driver; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/LoggingRunnableProcessObserver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/LoggingRunnableProcessObserver.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/LoggingRunnableProcessObserver.java index dd0d75e..25d88d4 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/LoggingRunnableProcessObserver.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/LoggingRunnableProcessObserver.java @@ -22,7 +22,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * A RunnableProcessObserver that logs the events/ + * A RunnableProcessObserver that logs the events/. */ public final class LoggingRunnableProcessObserver implements RunnableProcessObserver { private static final Logger LOG = Logger.getLogger(LoggingRunnableProcessObserver.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/ReefRunnableProcessObserver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/ReefRunnableProcessObserver.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/ReefRunnableProcessObserver.java index 3d5051a..6f1d007 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/ReefRunnableProcessObserver.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/ReefRunnableProcessObserver.java @@ -33,7 +33,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * a RunnableProcessObserver that relies events to REEF's ResourceStatusHandler + * a RunnableProcessObserver that relies events to REEF's ResourceStatusHandler. */ @ThreadSafe public final class ReefRunnableProcessObserver implements RunnableProcessObserver { @@ -94,7 +94,7 @@ public final class ReefRunnableProcessObserver implements RunnableProcessObserve } /** - * Inform REEF of an unclean process exit + * Inform REEF of an unclean process exit. * * @param processId * @param exitCode http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/RunnableProcess.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/RunnableProcess.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/RunnableProcess.java index d55e138..e44cd26 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/RunnableProcess.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/process/RunnableProcess.java @@ -109,7 +109,7 @@ public final class RunnableProcess implements Runnable { } /** - * Checks whether a transition from State 'from' to state 'to' is legal + * Checks whether a transition from State 'from' to state 'to' is legal. * * @param from * @param to http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/MesosClientConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/MesosClientConfiguration.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/MesosClientConfiguration.java index 5e5e4e6..d3468d4 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/MesosClientConfiguration.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/MesosClientConfiguration.java @@ -34,7 +34,7 @@ import org.apache.reef.tang.formats.OptionalParameter; import org.apache.reef.tang.formats.RequiredParameter; /** - * A ConfigurationModule for the Mesos resource manager + * A ConfigurationModule for the Mesos resource manager. */ @Public @ClientSide @@ -46,7 +46,7 @@ public class MesosClientConfiguration extends ConfigurationModuleBuilder { public static final OptionalParameter<String> ROOT_FOLDER = new OptionalParameter<>(); /** - * The ip address of Mesos Master + * The ip address of Mesos Master. */ public static final RequiredParameter<String> MASTER_IP = new RequiredParameter<>(); @@ -58,4 +58,4 @@ public class MesosClientConfiguration extends ConfigurationModuleBuilder { .bindConstructor(Configuration.class, HDFSConfigurationConstructor.class) .bindImplementation(RuntimeClasspathProvider.class, MesosClasspathProvider.class) .build(); -} \ No newline at end of file +} http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosDriverConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosDriverConfiguration.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosDriverConfiguration.java index 2ef844d..e83b5d9 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosDriverConfiguration.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosDriverConfiguration.java @@ -40,7 +40,7 @@ import org.apache.reef.wake.impl.SingleThreadStage; import org.apache.reef.wake.time.Clock; /** - * Binds Driver's runtime event handlers + * Binds Driver's runtime event handlers. */ public final class MesosDriverConfiguration extends ConfigurationModuleBuilder { /** @@ -54,7 +54,7 @@ public final class MesosDriverConfiguration extends ConfigurationModuleBuilder { public static final OptionalParameter<Long> EVALUATOR_TIMEOUT = new OptionalParameter<>(); /** - * The ip address of Mesos Master + * The ip address of Mesos Master. */ public static final RequiredParameter<String> MESOS_MASTER_IP = new RequiredParameter<>(); @@ -69,7 +69,7 @@ public final class MesosDriverConfiguration extends ConfigurationModuleBuilder { public static final OptionalParameter<Double> JVM_HEAP_SLACK = new OptionalParameter<>(); /** - * Capacity for runnning Mesos Scheduler Driver + * Capacity for runnning Mesos Scheduler Driver. */ public static final RequiredParameter<Integer> SCHEDULER_DRIVER_CAPACITY = new RequiredParameter<>(); @@ -95,4 +95,4 @@ public final class MesosDriverConfiguration extends ConfigurationModuleBuilder { .bindNamedParameter(AbstractDriverRuntimeConfiguration.ClientRemoteIdentifier.class, CLIENT_REMOTE_IDENTIFIER) .bindNamedParameter(JVMHeapSlack.class, JVM_HEAP_SLACK) .build(); -} \ No newline at end of file +} http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/REEFScheduler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/REEFScheduler.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/REEFScheduler.java index 1b94182..a5bea5e 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/REEFScheduler.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/REEFScheduler.java @@ -148,7 +148,7 @@ final class REEFScheduler implements Scheduler { } /** - * All offers in each batch of offers will be either be launched or declined + * All offers in each batch of offers will be either be launched or declined. */ @Override public void resourceOffers(final SchedulerDriver driver, final List<Protos.Offer> offers) { @@ -505,4 +505,4 @@ final class REEFScheduler implements Scheduler { throw new RuntimeException(e); } } -} \ No newline at end of file +} http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/EvaluatorControlHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/EvaluatorControlHandler.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/EvaluatorControlHandler.java index 20287e1..33693a0 100644 --- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/EvaluatorControlHandler.java +++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/EvaluatorControlHandler.java @@ -28,7 +28,7 @@ import org.apache.reef.wake.remote.RemoteMessage; import javax.inject.Inject; /** - * Handles evaluator launch requests via MesosRemoteManager from MesosResourceLaunchHandler + * Handles evaluator launch requests via MesosRemoteManager from MesosResourceLaunchHandler. */ @EvaluatorSide @Private @@ -52,4 +52,4 @@ final class EvaluatorControlHandler implements EventHandler<RemoteMessage<Evalua throw new IllegalArgumentException(); } } -} \ No newline at end of file +} http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/ClassPathBuilder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/ClassPathBuilder.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/ClassPathBuilder.java index 5a96b87..fd4f36d 100644 --- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/ClassPathBuilder.java +++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/ClassPathBuilder.java @@ -65,7 +65,7 @@ final class ClassPathBuilder { } /** - * Adds the given classPathEntry to the classpath suffix + * Adds the given classPathEntry to the classpath suffix. * * @param classPathEntry */ @@ -74,7 +74,7 @@ final class ClassPathBuilder { } /** - * Adds the given classPathEntry to the classpath prefix + * Adds the given classPathEntry to the classpath prefix. * * @param classPathEntry */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/YarnClasspathProvider.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/YarnClasspathProvider.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/YarnClasspathProvider.java index 0a732ad..569f27f 100644 --- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/YarnClasspathProvider.java +++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/YarnClasspathProvider.java @@ -111,7 +111,7 @@ public final class YarnClasspathProvider implements RuntimeClasspathProvider { } /** - * Fetches the string[] under the given key, if it exists and contains entries (.length >0) + * Fetches the string[] under the given key, if it exists and contains entries (.length >0). * * @param configuration * @param key http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/uploader/JobFolder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/uploader/JobFolder.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/uploader/JobFolder.java index 8ea1df1..157e447 100644 --- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/uploader/JobFolder.java +++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/uploader/JobFolder.java @@ -57,7 +57,7 @@ public final class JobFolder { } /** - * Uploads the given file to the DFS + * Uploads the given file to the DFS. * * @param localFile * @return the Path representing the file on the DFS. @@ -94,7 +94,7 @@ public final class JobFolder { } /** - * Creates a LocalResource instance for the JAR file referenced by the given Path + * Creates a LocalResource instance for the JAR file referenced by the given Path. */ public LocalResource getLocalResourceForPath(final Path path) throws IOException { final LocalResource localResource = Records.newRecord(LocalResource.class); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/Containers.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/Containers.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/Containers.java index b3f4ac1..467449b 100644 --- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/Containers.java +++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/Containers.java @@ -55,7 +55,7 @@ final class Containers { } /** - * Registers the given container + * Registers the given container. * * @param container * @throws java.lang.RuntimeException if a container with the same ID had been registered before. http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/UploaderToJobfolder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/UploaderToJobfolder.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/UploaderToJobfolder.java index afc1d9c..a17dfb8 100644 --- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/UploaderToJobfolder.java +++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/UploaderToJobfolder.java @@ -75,7 +75,7 @@ final class UploaderToJobFolder { } /** - * Creates a LocalResource instance for the JAR file referenced by the given Path + * Creates a LocalResource instance for the JAR file referenced by the given Path. * * @param path * @return http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerManager.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerManager.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerManager.java index 37fc784..1a46a48 100644 --- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerManager.java +++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/driver/YarnContainerManager.java @@ -502,7 +502,7 @@ final class YarnContainerManager } /** - * Update the driver with my current status + * Update the driver with my current status. */ private void updateRuntimeStatus() { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/util/YarnTypes.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/util/YarnTypes.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/util/YarnTypes.java index ad60db0..1613298 100644 --- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/util/YarnTypes.java +++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/util/YarnTypes.java @@ -28,7 +28,7 @@ import java.util.List; import java.util.Map; /** - * Helper class that creates the various records in the YARN API + * Helper class that creates the various records in the YARN API. */ @Private public final class YarnTypes { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/Configurations.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/Configurations.java b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/Configurations.java index a7450bc..7560de0 100644 --- a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/Configurations.java +++ b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/Configurations.java @@ -19,7 +19,7 @@ package org.apache.reef.tang; /** - * Helper class for Configurations + * Helper class for Configurations. */ public final class Configurations { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/JavaClassHierarchy.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/JavaClassHierarchy.java b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/JavaClassHierarchy.java index 27aa6cb..b08808a 100644 --- a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/JavaClassHierarchy.java +++ b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/JavaClassHierarchy.java @@ -55,7 +55,7 @@ public interface JavaClassHierarchy extends ClassHierarchy { public <T> T parse(NamedParameterNode<T> name, String value) throws ParseException; /** - * Obtain a parsed instance of the default value of a named parameter + * Obtain a parsed instance of the default value of a named parameter. * * @param name The named parameter that should be checked for a default instance. * @return The default instance or null, unless T is a set type. If T is a set, http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/JavaConfigurationBuilder.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/JavaConfigurationBuilder.java b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/JavaConfigurationBuilder.java index ace0080..a2ae641 100644 --- a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/JavaConfigurationBuilder.java +++ b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/JavaConfigurationBuilder.java @@ -51,7 +51,7 @@ public interface JavaConfigurationBuilder extends ConfigurationBuilder { public <T> JavaConfigurationBuilder bind(Class<T> iface, Class<?> impl) throws BindException; /** - * Binds the Class impl as the implementation of the interface iface + * Binds the Class impl as the implementation of the interface iface. * * @param <T> * @param iface @@ -95,4 +95,4 @@ public interface JavaConfigurationBuilder extends ConfigurationBuilder { */ public <T> JavaConfigurationBuilder bindList(Class<? extends Name<List<T>>> iface, List impl) throws BindException; -} \ No newline at end of file +} http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/formats/AvroConfigurationSerializer.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/formats/AvroConfigurationSerializer.java b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/formats/AvroConfigurationSerializer.java index 98f455a..b090542 100644 --- a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/formats/AvroConfigurationSerializer.java +++ b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/formats/AvroConfigurationSerializer.java @@ -231,7 +231,7 @@ public final class AvroConfigurationSerializer implements ConfigurationSerialize } /** - * Converts a given AvroConfiguration to Configuration + * Converts a given AvroConfiguration to Configuration. * * @param avroConfiguration * @return a Configuration version of the given AvroConfiguration @@ -243,7 +243,7 @@ public final class AvroConfigurationSerializer implements ConfigurationSerialize } /** - * Converts a given AvroConfiguration to Configuration + * Converts a given AvroConfiguration to Configuration. * * @param avroConfiguration * @param classHierarchy the class hierarchy used for validation. http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/formats/ConfigurationSerializer.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/formats/ConfigurationSerializer.java b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/formats/ConfigurationSerializer.java index 46fcaff..a384d18 100644 --- a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/formats/ConfigurationSerializer.java +++ b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/formats/ConfigurationSerializer.java @@ -90,7 +90,7 @@ public interface ConfigurationSerializer { public Configuration fromTextFile(final File file) throws IOException, BindException; /** - * Loads a Configuration from a File created with toFile() with ClassHierarchy + * Loads a Configuration from a File created with toFile() with ClassHierarchy. * * @param file * @param classHierarchy @@ -132,7 +132,7 @@ public interface ConfigurationSerializer { public Configuration fromByteArray(final byte[] theBytes, final ClassHierarchy classHierarchy) throws IOException, BindException; /** - * Decodes a String generated via toString() + * Decodes a String generated via toString(). * * @param theString to be parsed * @return the Configuration stored in theString. @@ -142,7 +142,7 @@ public interface ConfigurationSerializer { public Configuration fromString(final String theString) throws IOException, BindException; /** - * Decodes a String generated via toString() + * Decodes a String generated via toString(). * * @param theString to be parsed * @param classHierarchy used to validate the configuration against http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/implementation/protobuf/ProtocolBufferClassHierarchy.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/implementation/protobuf/ProtocolBufferClassHierarchy.java b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/implementation/protobuf/ProtocolBufferClassHierarchy.java index 0e0a0c6..0cf9a2f 100644 --- a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/implementation/protobuf/ProtocolBufferClassHierarchy.java +++ b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/implementation/protobuf/ProtocolBufferClassHierarchy.java @@ -203,7 +203,7 @@ public class ProtocolBufferClassHierarchy implements ClassHierarchy { } /** - * serialize a class hierarchy into a file + * serialize a class hierarchy into a file. * * @param file * @param classHierarchy http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/util/walk/graphviz/GraphvizConfigVisitor.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/util/walk/graphviz/GraphvizConfigVisitor.java b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/util/walk/graphviz/GraphvizConfigVisitor.java index cecd04f..3317b65 100644 --- a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/util/walk/graphviz/GraphvizConfigVisitor.java +++ b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/util/walk/graphviz/GraphvizConfigVisitor.java @@ -34,7 +34,7 @@ public final class GraphvizConfigVisitor extends AbstractClassHierarchyNodeVisitor implements EdgeVisitor<Node> { /** - * Legend for the configuration graph in Graphviz format + * Legend for the configuration graph in Graphviz format. */ private static final String LEGEND = " subgraph cluster_legend {\n" http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/util/walk/graphviz/GraphvizInjectionPlanVisitor.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/util/walk/graphviz/GraphvizInjectionPlanVisitor.java b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/util/walk/graphviz/GraphvizInjectionPlanVisitor.java index 2c5f785..e7d455f 100644 --- a/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/util/walk/graphviz/GraphvizInjectionPlanVisitor.java +++ b/lang/java/reef-tang/tang/src/main/java/org/apache/reef/tang/util/walk/graphviz/GraphvizInjectionPlanVisitor.java @@ -32,7 +32,7 @@ import org.apache.reef.tang.util.walk.Walk; public final class GraphvizInjectionPlanVisitor extends AbstractInjectionPlanNodeVisitor implements EdgeVisitor<InjectionPlan<?>> { /** - * Legend for the configuration graph in Graphviz format + * Legend for the configuration graph in Graphviz format. */ private static final String LEGEND = " subgraph cluster_legend {\n" http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-tests/src/main/java/org/apache/reef/tests/library/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/library/package-info.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/library/package-info.java index df3a0e3..e6316b4 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/library/package-info.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/library/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * Commonly used event handlers and task implementations in our tests + * Commonly used event handlers and task implementations in our tests. */ -package org.apache.reef.tests.library; \ No newline at end of file +package org.apache.reef.tests.library; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureREEF.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureREEF.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureREEF.java index 268e462..61f769d 100644 --- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureREEF.java +++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/yarn/failure/FailureREEF.java @@ -40,7 +40,7 @@ import java.util.logging.Logger; public final class FailureREEF { /** - * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently + * The upper limit on the number of Evaluators that the local resourcemanager will hand out concurrently. */ public static final int MAX_NUMBER_OF_EVALUATORS = 16; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/Cache.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/Cache.java b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/Cache.java index ef78753..716e39d 100644 --- a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/Cache.java +++ b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/Cache.java @@ -28,7 +28,7 @@ import java.util.concurrent.ExecutionException; */ public interface Cache<K, V> { /** - * Returns a value for the key if cached; otherwise creates, caches and returns + * Returns a value for the key if cached; otherwise creates, caches and returns. * When it creates a value for a key, only one callable for the key is executed * * @param key a key @@ -39,7 +39,7 @@ public interface Cache<K, V> { public V get(K key, Callable<V> valueFetcher) throws ExecutionException; /** - * Invalidates a key from the cache + * Invalidates a key from the cache. * * @param key a key */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/CacheImpl.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/CacheImpl.java b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/CacheImpl.java index 778fcb3..04cd88d 100644 --- a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/CacheImpl.java +++ b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/CacheImpl.java @@ -54,7 +54,7 @@ public final class CacheImpl<K, V> implements Cache<K, V> { private long expireCheckedTime; /** - * Construct an expire-after-write cache + * Construct an expire-after-write cache. * * @param currentTime class that returns the current time for timeout purposes * @param timeoutMillis a cache entry timeout after write http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/CurrentTime.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/CurrentTime.java b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/CurrentTime.java index 6157210..286c6a9 100644 --- a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/CurrentTime.java +++ b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/CurrentTime.java @@ -19,7 +19,7 @@ package org.apache.reef.util.cache; /** - * Return the current time + * Return the current time. */ public interface CurrentTime { long now(); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/SystemTime.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/SystemTime.java b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/SystemTime.java index c1d19ce..9a56781 100644 --- a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/SystemTime.java +++ b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/SystemTime.java @@ -19,7 +19,7 @@ package org.apache.reef.util.cache; /** - * Return the system time + * Return the system time. */ public final class SystemTime implements CurrentTime { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/WrappedValue.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/WrappedValue.java b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/WrappedValue.java index abc2a07..fdad4b8 100644 --- a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/WrappedValue.java +++ b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/WrappedValue.java @@ -60,7 +60,7 @@ final class WrappedValue<V> { } /** - * Must only be called once, by the thread that created this WrappedValue + * Must only be called once, by the thread that created this WrappedValue. * @return The value returned by valueFetcher */ public synchronized V loadAndGet() throws ExecutionException { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/AbstractEStage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/AbstractEStage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/AbstractEStage.java index 30cf265..684bf24 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/AbstractEStage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/AbstractEStage.java @@ -23,7 +23,7 @@ import org.apache.reef.wake.metrics.Meter; import java.util.concurrent.atomic.AtomicBoolean; /** - * An {@link EStage} that implements metering + * An {@link EStage} that implements metering. * * @param <T> type */ @@ -34,12 +34,12 @@ public abstract class AbstractEStage<T> implements EStage<T> { protected final Meter inMeter; /** - * outputs share a single meter + * outputs share a single meter. */ protected final Meter outMeter; /** - * Constructs an abstract estage + * Constructs an abstract estage. * * @parm stageName the stage name */ @@ -51,7 +51,7 @@ public abstract class AbstractEStage<T> implements EStage<T> { } /** - * Gets the input meter of this stage + * Gets the input meter of this stage. * * @return the input meter */ @@ -60,7 +60,7 @@ public abstract class AbstractEStage<T> implements EStage<T> { } /** - * Gets the output meter of this stage + * Gets the output meter of this stage. * * @return the output meter */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/EStage.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/EStage.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/EStage.java index 5e79d39..d0df6ba 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/EStage.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/EStage.java @@ -19,7 +19,7 @@ package org.apache.reef.wake; /** - * Stage that executes an event handler + * Stage that executes an event handler. * * @param <T> type */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/EventHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/EventHandler.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/EventHandler.java index 871e64e..57b38b5 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/EventHandler.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/EventHandler.java @@ -19,14 +19,14 @@ package org.apache.reef.wake; /** - * Handler to process an event + * Handler to process an event. * * @param <T> type */ public interface EventHandler<T> { /** - * Handles an event + * Handles an event. * * @param value an event */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Identifiable.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Identifiable.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Identifiable.java index 784dafb..49addae 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Identifiable.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Identifiable.java @@ -21,7 +21,7 @@ package org.apache.reef.wake; public interface Identifiable { /** - * Returns an identifier of this object + * Returns an identifier of this object. * * @return an identifier of this object */ http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Identifier.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Identifier.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Identifier.java index 377b23e..ee599de 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Identifier.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/Identifier.java @@ -29,14 +29,14 @@ package org.apache.reef.wake; public interface Identifier { /** - * Returns a hash code for the object + * Returns a hash code for the object. * * @return a hash code value for this object */ public int hashCode(); /** - * Checks that another object is equal to this object + * Checks that another object is equal to this object. * * @param o another object * @return true if the object is the same as the object argument; false, http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/eeafba31/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/IdentifierFactory.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/IdentifierFactory.java b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/IdentifierFactory.java index 828eda9..8a39c61 100644 --- a/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/IdentifierFactory.java +++ b/lang/java/reef-wake/wake/src/main/java/org/apache/reef/wake/IdentifierFactory.java @@ -21,7 +21,7 @@ package org.apache.reef.wake; public interface IdentifierFactory { /** - * Creates a RemoteIdentifier object + * Creates a RemoteIdentifier object. * * @param str a string * @return an identifier
