hazelcast-master/hazelcast/src/main/java/com/hazelcast/config/ConfigRecognizer.java
/*
 * Copyright (c) 2008-2023, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed 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 com.hazelcast.config;

/**
 * Interface for recognizing a declarative Hazelcast configuration
 * based on the rules defined in the actual implementation.
 * The main use case for this interface is recognizing whether a given
 * declarative configuration is a member or a client configuration.
 */
public interface ConfigRecognizer {
    /**
     * Recognizes the configuration given in the {@code configStream}
     * argument.
     *
     * @param configStream The stream with the declarative configuration
     * @return {@code true} if the configuration is recognized, {@code false}
     * otherwise
     * @throws Exception If any error occurs during the recognition
     */
    boolean isRecognized(ConfigStream configStream) throws Exception;
}
