org.apache.flink.table.catalog.CatalogDatabaseImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flink-table-api-java Show documentation

This module contains the Table/SQL API for writing table programs within the table ecosystem using the Java programming language.

The newest version!

/*
 * 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.table.catalog;

import javax.annotation.Nullable;

import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * A implementation of {@link CatalogDatabase}.
 */
public class CatalogDatabaseImpl implements CatalogDatabase {
	// Property of the database
	private final Map properties;
	// Comment of the database
	private final String comment;

	public CatalogDatabaseImpl(Map properties, @Nullable String comment) {
		this.properties = checkNotNull(properties, "properties cannot be null");
		this.comment = comment;
	}

	/**
	 * Get a map of properties associated with the database.
	 */
	public Map getProperties() {
		return properties;
	}

	/**
	 * Get comment of the database.
	 *
	 * @return comment of the database
	 */
	public String getComment() {
		return comment;
	}

	/**
	 * Get a deep copy of the CatalogDatabase instance.
	 *
	 * @return a copy of CatalogDatabase instance
	 */
	public CatalogDatabase copy() {
		return new CatalogDatabaseImpl(new HashMap<>(properties), comment);
	}

	/**
	 * Get a brief description of the database.
	 *
	 * @return an optional short description of the database
	 */
	public Optional getDescription() {
		return Optional.ofNullable(comment);
	}

	/**
	 * Get a detailed description of the database.
	 *
	 * @return an optional long description of the database
	 */
	public Optional getDetailedDescription() {
		return Optional.ofNullable(comment);
	}
}