/*
 * 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.pulsar.common.naming;

/**
 * Basic interface for service unit's identification.
 */
public interface ServiceUnitId {

    @Override
    String toString();

    /**
     * Return the namespace object that this <code>ServiceUnitId</code> belongs to.
     *
     * @return NamespaceName object
     */
    NamespaceName getNamespaceObject();

    /**
     * Check whether a fully-qualified topic is included in this <code>ServiceUnitId</code> object.
     *
     * @param topicName
     *            a fully-qualified topic object
     * @return true or false
     */
    boolean includes(TopicName topicName);
}
