org.apache.flink.runtime.clusterframework.types.ResourceID Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.10 Show documentation

There is a newer version: 1.3.3

/*
 * 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.
 */

package org.apache.flink.runtime.clusterframework.types;

import org.apache.flink.util.AbstractID;
import org.apache.flink.util.Preconditions;

import java.io.Serializable;

/**
 * Class for Resource Ids assigned at the FlinkResourceManager.
 */
public final class ResourceID implements ResourceIDRetrievable, Serializable {

	private static final long serialVersionUID = 42L;

	private final String resourceId;

	public ResourceID(String resourceId) {
		Preconditions.checkNotNull(resourceId, "ResourceID must not be null");
		this.resourceId = resourceId;
	}

	/**
	 * Gets the Resource Id as string
	 * @return Stringified version of the ResourceID
	 */
	public final String getResourceIdString() {
		return resourceId;
	}

	@Override
	public final boolean equals(Object o) {
		if (this == o) {
			return true;
		} else if (o == null || o.getClass() != getClass()) {
			return false;
		} else {
			return resourceId.equals(((ResourceID) o).resourceId);
		}
	}

	@Override
	public final int hashCode() {
		return resourceId.hashCode();
	}

	@Override
	public String toString() {
		return "ResourceID{" +
			"resourceId='" + resourceId + '\'' +
			'}';
	}

	/**
	 * A ResourceID can always retrieve a ResourceID.
	 * @return This instance.
	 */
	@Override
	public ResourceID getResourceID() {
		return this;
	}
	
	/**
	 * Generate a random resource id.
	 * @return A random resource id.
	 */
	public static ResourceID generate() {
		return new ResourceID(new AbstractID().toString());
	}
}