org.apache.flink.table.client.config.entries.ConfigEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flink-sql-client 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.table.client.config.entries;

import org.apache.flink.table.api.ValidationException;
import org.apache.flink.table.client.SqlClientException;
import org.apache.flink.table.descriptors.DescriptorProperties;

import java.util.Map;
import java.util.Objects;

/**
 * Describes an environment configuration entry (such as table, functions, views). Config entries
 * are similar to {@link org.apache.flink.table.descriptors.Descriptor} but apply to SQL Client's
 * environment files only.
 */
abstract class ConfigEntry {

	protected final DescriptorProperties properties;

	protected ConfigEntry(DescriptorProperties properties) {
		try {
			validate(properties);
		} catch (ValidationException e) {
			throw new SqlClientException("Invalid configuration entry.", e);
		}

		this.properties = properties;
	}

	/**
	 * Performs syntactic validation.
	 */
	protected abstract void validate(DescriptorProperties properties);

	public Map asMap() {
		return properties.asMap();
	}

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

	@Override
	public int hashCode() {
		return Objects.hash(properties);
	}
}