hazelcast-master/hazelcast-sql/src/main/java/com/hazelcast/sql/impl/schema/SqlCatalogObject.java
/*
 * Copyright 2023 Hazelcast Inc.
 *
 * Licensed under the Hazelcast Community License (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://hazelcast.com/hazelcast-community-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 OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hazelcast.sql.impl.schema;

import com.hazelcast.nio.serialization.IdentifiedDataSerializable;
import com.hazelcast.sql.impl.SqlDataSerializerHook;

import javax.annotation.Nonnull;

/**
 * Interface for catalog objects which support unparsing to DDL.
 */
public interface SqlCatalogObject extends IdentifiedDataSerializable {

    /**
     * @return DDL statement to create this object.
     */
    @Nonnull
    String unparse();

    @Override
    default int getFactoryId() {
        return SqlDataSerializerHook.F_ID;
    }
}
