org.apache.flink.runtime.state.DirectoryStateHandle Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.11 Show documentation
There is a newer version: 1.5.1
/*
 * 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.state;

import org.apache.flink.core.fs.FileSystem;
import org.apache.flink.core.fs.Path;

import javax.annotation.Nonnull;

import java.io.IOException;

/**
 * This state handle represents a directory. This class is, for example, used to represent the directory of RocksDB's
 * native checkpoint directories for local recovery.
 */
public class DirectoryStateHandle implements StateObject {

	/** Serial version. */
	private static final long serialVersionUID = 1L;

	/** The path that describes the directory. */
	@Nonnull
	protected final Path directory;

	public DirectoryStateHandle(@Nonnull Path directory) {
		this.directory = directory;
	}

	@Override
	public void discardState() throws IOException {
		FileSystem fileSystem = directory.getFileSystem();
		fileSystem.delete(directory, true);
	}

	@Override
	public long getStateSize() {
		// For now, we will not report any size, but in the future this could (if needed) return the total dir size.
		return 0L; // unknown
	}

	@Nonnull
	public Path getDirectory() {
		return directory;
	}

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

		DirectoryStateHandle that = (DirectoryStateHandle) o;

		return directory.equals(that.directory);
	}

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

	@Override
	public String toString() {
		return "DirectoryStateHandle{" +
			"directory=" + directory +
			'}';
	}
}