type-system/src/main/java/org/apache/sling/experimental/typesystem/service/TypeSystem.java

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ~ 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.sling.experimental.typesystem.service;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.experimental.typesystem.Type;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.osgi.annotation.versioning.ProviderType;

/**
 * The {@code TypeService} allows retrieving {@link Type} information for a certain resource.
 */
@ProviderType
public interface TypeSystem {

    /**
     * Retrieves a {@link Resource}'s {@link Type}, if one was defined.
     *
     * @param resource the resource for which to retrieve the type
     * @return the {@code Type}, if one was defined; {@code null} otherwise
     */
    @Nullable
    Type getType(@NotNull Resource resource);

}