You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by se...@apache.org on 2014/09/21 04:12:43 UTC

[19/63] [abbrv] git commit: Make IDs immutable and serializable.

Make IDs immutable and serializable.


Project: http://git-wip-us.apache.org/repos/asf/incubator-flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-flink/commit/9035b6d0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-flink/tree/9035b6d0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-flink/diff/9035b6d0

Branch: refs/heads/master
Commit: 9035b6d0cfbe02a3b5d6d6726d3bd41e50586fdb
Parents: cb7039e
Author: Stephan Ewen <se...@apache.org>
Authored: Mon Jun 23 19:44:18 2014 +0200
Committer: Stephan Ewen <se...@apache.org>
Committed: Sat Sep 20 20:02:48 2014 +0200

----------------------------------------------------------------------
 .../org/apache/flink/runtime/AbstractID.java    | 14 ++-------
 .../executiongraph/ExecutionVertexID.java       | 32 +++++++++++++-------
 .../flink/runtime/instance/InstanceID.java      |  4 ++-
 .../runtime/io/network/channels/ChannelID.java  |  6 ++--
 .../flink/runtime/io/network/gates/GateID.java  |  4 +--
 .../apache/flink/runtime/jobgraph/JobID.java    |  7 ++---
 .../flink/runtime/jobgraph/JobVertexID.java     |  4 ++-
 .../jobmanager/scheduler/ResourceId.java        | 29 ++++++++++--------
 .../managementgraph/ManagementEdgeID.java       | 20 ++++--------
 .../managementgraph/ManagementGateID.java       |  6 +---
 .../ManagementGroupVertexID.java                | 17 ++---------
 .../managementgraph/ManagementVertexID.java     | 13 +++++---
 .../apache/flink/runtime/AbstractIDTest.java    | 19 ++----------
 13 files changed, 75 insertions(+), 100 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/AbstractID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/AbstractID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/AbstractID.java
index 458907c..c187961 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/AbstractID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/AbstractID.java
@@ -32,7 +32,9 @@ import io.netty.buffer.ByteBuf;
 /**
  * A statistically unique identification number.
  */
-public class AbstractID implements IOReadableWritable, Comparable<AbstractID> {
+public class AbstractID implements IOReadableWritable, Comparable<AbstractID>, java.io.Serializable {
+
+	private static final long serialVersionUID = 1L;
 
 	/** The size of a long in bytes */
 	private static final int SIZE_OF_LONG = 8;
@@ -129,16 +131,6 @@ public class AbstractID implements IOReadableWritable, Comparable<AbstractID> {
 			ba[offset + SIZE_OF_LONG - 1 - i] = (byte) ((l & (0xffL << shift)) >>> shift);
 		}
 	}
-
-	/**
-	 * Sets an ID from another ID by copying its internal byte representation.
-	 *
-	 * @param src source ID
-	 */
-	public void setID(AbstractID src) {
-		this.lowerPart = src.lowerPart;
-		this.upperPart = src.upperPart;
-	}
 	
 	// --------------------------------------------------------------------------------------------
 

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/ExecutionVertexID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/ExecutionVertexID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/ExecutionVertexID.java
index 7088ec1..87e2120 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/ExecutionVertexID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/ExecutionVertexID.java
@@ -28,6 +28,24 @@ import org.apache.flink.runtime.managementgraph.ManagementVertexID;
  */
 public class ExecutionVertexID extends AbstractID {
 
+	private static final long serialVersionUID = 1L;
+	
+	/**
+	 * Creates a new random execution vertex id.
+	 */
+	public ExecutionVertexID() {
+		super();
+	}
+	
+	/**
+	 * Creates a new execution vertex id, equal to the given id.
+	 * 
+	 * @param from The id to copy.
+	 */
+	public ExecutionVertexID(AbstractID from) {
+		super(from);
+	}
+	
 	/**
 	 * Converts the execution vertex ID into a
 	 * management vertex ID. The new management vertex ID
@@ -38,11 +56,7 @@ public class ExecutionVertexID extends AbstractID {
 	 * @return the new management vertex ID
 	 */
 	public ManagementVertexID toManagementVertexID() {
-
-		final ManagementVertexID newID = new ManagementVertexID();
-		newID.setID(this);
-
-		return newID;
+		return new ManagementVertexID(this);
 	}
 
 	/**
@@ -54,11 +68,7 @@ public class ExecutionVertexID extends AbstractID {
 	 *        the management vertex ID to be converted
 	 * @return the resulting execution vertex ID
 	 */
-	public static ExecutionVertexID fromManagementVertexID(final ManagementVertexID vertexID) {
-
-		final ExecutionVertexID newID = new ExecutionVertexID();
-		newID.setID(vertexID);
-
-		return newID;
+	public static ExecutionVertexID fromManagementVertexID(ManagementVertexID vertexID) {
+		return new ExecutionVertexID(vertexID);
 	}
 }

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/instance/InstanceID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/instance/InstanceID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/instance/InstanceID.java
index 9c922af..cc0d819 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/instance/InstanceID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/instance/InstanceID.java
@@ -23,4 +23,6 @@ import org.apache.flink.runtime.AbstractID;
 /**
  * Class for statistically unique instance IDs.
  */
-public class InstanceID extends AbstractID {}
+public class InstanceID extends AbstractID {
+	private static final long serialVersionUID = 1L;
+}

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/channels/ChannelID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/channels/ChannelID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/channels/ChannelID.java
index 9c9575d..d1c09d2 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/channels/ChannelID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/channels/ChannelID.java
@@ -25,6 +25,8 @@ import org.apache.flink.runtime.AbstractID;
 
 public class ChannelID extends AbstractID {
 
+	private static final long serialVersionUID = 1L;
+	
 	public ChannelID() {
 		super();
 	}
@@ -33,8 +35,8 @@ public class ChannelID extends AbstractID {
 		super(lowerPart, upperPart);
 	}
 
-	public ChannelID(byte[] bytes) {
-		super(bytes);
+	public ChannelID(AbstractID id) {
+		super(id);
 	}
 
 	public static ChannelID fromByteBuffer(ByteBuffer buf) {

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/gates/GateID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/gates/GateID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/gates/GateID.java
index e106ad9..954f527 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/gates/GateID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/gates/GateID.java
@@ -16,15 +16,13 @@
  * limitations under the License.
  */
 
-
 package org.apache.flink.runtime.io.network.gates;
 
 import org.apache.flink.runtime.AbstractID;
 
 /**
  * A class for statistically unique gate IDs.
- * 
  */
 public final class GateID extends AbstractID {
-
+	private static final long serialVersionUID = 1L;
 }

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/JobID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/JobID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/JobID.java
index 27eebc1..be2fcc1 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/JobID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/JobID.java
@@ -27,6 +27,8 @@ import java.nio.ByteBuffer;
 
 public final class JobID extends AbstractID {
 
+	private static final long serialVersionUID = 1L;
+	
 	public JobID() {
 		super();
 	}
@@ -40,10 +42,7 @@ public final class JobID extends AbstractID {
 	}
 
 	public static JobID generate() {
-		long lowerPart = AbstractID.generateRandomLong();
-		long upperPart = AbstractID.generateRandomLong();
-
-		return new JobID(lowerPart, upperPart);
+		return new JobID();
 	}
 
 	public static JobID fromByteArray(byte[] bytes) {

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/JobVertexID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/JobVertexID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/JobVertexID.java
index 6a56c19..cb63b06 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/JobVertexID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/JobVertexID.java
@@ -23,4 +23,6 @@ import org.apache.flink.runtime.AbstractID;
 /**
  * A class for statistically unique job vertex IDs.
  */
-public class JobVertexID extends AbstractID {}
+public class JobVertexID extends AbstractID {
+	private static final long serialVersionUID = 1L;
+}

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/ResourceId.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/ResourceId.java b/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/ResourceId.java
index 58833f4..ab98b68 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/ResourceId.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/ResourceId.java
@@ -1,20 +1,25 @@
-/***********************************************************************************************************************
- *
- * Copyright (C) 2010-2013 by the Stratosphere project (http://stratosphere.eu)
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
- * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations under the License.
- *
- **********************************************************************************************************************/
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
 package org.apache.flink.runtime.jobmanager.scheduler;
 
 import org.apache.flink.runtime.AbstractID;
 
-public class ResourceId extends AbstractID {}
+public class ResourceId extends AbstractID {
+	private static final long serialVersionUID = 1L;
+}

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementEdgeID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementEdgeID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementEdgeID.java
index 955f064..16ba974 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementEdgeID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementEdgeID.java
@@ -16,7 +16,6 @@
  * limitations under the License.
  */
 
-
 package org.apache.flink.runtime.managementgraph;
 
 import org.apache.flink.runtime.AbstractID;
@@ -24,17 +23,15 @@ import org.apache.flink.runtime.io.network.channels.ChannelID;
 
 /**
  * A management edge ID uniquely identifies a {@link ManagementEdge}.
- * <p>
- * This class is not thread-safe.
- * 
  */
 public class ManagementEdgeID extends AbstractID {
-
+	
+	private static final long serialVersionUID = 1L;
+	
 	/**
 	 * Initializes ManagementEdgeID.
 	 */
-	ManagementEdgeID() {
-	}
+	public ManagementEdgeID() {}
 
 	/**
 	 * A ManagementEdgeID is derived from the #{@link ChannelID} of the corresponding
@@ -44,8 +41,7 @@ public class ManagementEdgeID extends AbstractID {
 	 *        ID of the corresponding output channel
 	 */
 	public ManagementEdgeID(ChannelID source) {
-		super();
-		this.setID(source);
+		super(source);
 	}
 
 	/**
@@ -54,10 +50,6 @@ public class ManagementEdgeID extends AbstractID {
 	 * @return the corresponding channelID.
 	 */
 	public ChannelID toChannelID() {
-
-		final ChannelID channelID = new ChannelID();
-		channelID.setID(this);
-
-		return channelID;
+		return new ChannelID(this);
 	}
 }

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementGateID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementGateID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementGateID.java
index 08a46d1..3e890d4 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementGateID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementGateID.java
@@ -16,17 +16,13 @@
  * limitations under the License.
  */
 
-
 package org.apache.flink.runtime.managementgraph;
 
 import org.apache.flink.runtime.AbstractID;
 
 /**
  * A management gate ID uniquely identifies a {@link ManagementGate}.
- * <p>
- * This class is not thread-safe.
- * 
  */
 public final class ManagementGateID extends AbstractID {
-
+	private static final long serialVersionUID = 1L;
 }

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementGroupVertexID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementGroupVertexID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementGroupVertexID.java
index 8038080..66465dd 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementGroupVertexID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementGroupVertexID.java
@@ -16,7 +16,6 @@
  * limitations under the License.
  */
 
-
 package org.apache.flink.runtime.managementgraph;
 
 import javax.xml.bind.DatatypeConverter;
@@ -25,16 +24,13 @@ import org.apache.flink.runtime.AbstractID;
 
 /**
  * A management group vertex ID uniquely identifies a {@link ManagementGroupVertex}.
- * <p>
- * This class is not thread-safe.
- * 
  */
 public final class ManagementGroupVertexID extends AbstractID {
 	
-	
+	private static final long serialVersionUID = 1L;
+
 	/**
 	 * Constructs a new ManagementGroupVertexID
-	 * 
 	 */
 	public ManagementGroupVertexID() {
 		super();
@@ -50,16 +46,7 @@ public final class ManagementGroupVertexID extends AbstractID {
 		super(bytes);
 	}
 	
-	/**
-	 * Constructs a new job ID and initializes it with the given bytes.
-	 * 
-	 * @param bytes
-	 *        the bytes to initialize the new job ID with
-	 * @return the new job ID
-	 */
 	public static ManagementGroupVertexID fromHexString(final String hexString) {
-
 		return new ManagementGroupVertexID(DatatypeConverter.parseHexBinary(hexString));
 	}
-	
 }

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementVertexID.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementVertexID.java b/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementVertexID.java
index d5a7ba0..92955e8 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementVertexID.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/managementgraph/ManagementVertexID.java
@@ -16,16 +16,21 @@
  * limitations under the License.
  */
 
-
 package org.apache.flink.runtime.managementgraph;
 
 import org.apache.flink.runtime.AbstractID;
 
 /**
  * A management vertex ID uniquely identifies a {@link ManagementVertex}.
- * <p>
- * This class is not thread-safe.
- * 
  */
 public final class ManagementVertexID extends AbstractID {
+	private static final long serialVersionUID = 1L;
+	
+	public ManagementVertexID() {
+		super();
+	}
+	
+	public ManagementVertexID(AbstractID toCopy) {
+		super(toCopy);
+	}
 }

http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/9035b6d0/flink-runtime/src/test/java/org/apache/flink/runtime/AbstractIDTest.java
----------------------------------------------------------------------
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/AbstractIDTest.java b/flink-runtime/src/test/java/org/apache/flink/runtime/AbstractIDTest.java
index e55012b..1e2a1ab 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/AbstractIDTest.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/AbstractIDTest.java
@@ -24,7 +24,6 @@ import static org.junit.Assert.fail;
 
 import org.junit.Test;
 
-import org.apache.flink.runtime.io.network.channels.ChannelID;
 import org.apache.flink.runtime.testutils.CommonTestUtils;
 
 /**
@@ -32,27 +31,13 @@ import org.apache.flink.runtime.testutils.CommonTestUtils;
  */
 public class AbstractIDTest {
 	/**
-	 * Tests the setID method of an abstract ID.
-	 */
-	@Test
-	public void testSetID() {
-
-		final ChannelID id1 = new ChannelID();
-		final ChannelID id2 = new ChannelID();
-		id1.setID(id2);
-
-		assertEquals(id1.hashCode(), id2.hashCode());
-		assertEquals(id1, id2);
-	}
-
-	/**
 	 * Tests the serialization/deserialization of an abstract ID.
 	 */
 	@Test
 	public void testSerialization() {
-		final ChannelID origID = new ChannelID();
+		final AbstractID origID = new AbstractID();
 		try {
-			final ChannelID copyID = (ChannelID) CommonTestUtils.createCopyWritable(origID);
+			final AbstractID copyID = (AbstractID) CommonTestUtils.createCopyWritable(origID);
 
 			assertEquals(origID.hashCode(), copyID.hashCode());
 			assertEquals(origID, copyID);