001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.jsonschema;
018
019import java.net.*;
020
021import org.apache.juneau.*;
022
023/**
024 * Interface used to retrieve identifiers and URIs for bean classes.
025 *
026 * <h5 class='section'>See Also:</h5><ul>
027 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JsonSchemaDetails">JSON-Schema Support</a>
028 * </ul>
029 */
030public interface BeanDefMapper {
031
032   /**
033    * Represents the absence of a bean definition mapper class.
034    */
035   public interface Void extends BeanDefMapper {}
036
037   /**
038    * Returns the ID for the specified class.
039    *
040    * @param cm The class.
041    * @return The ID for the specified class.
042    */
043   String getId(ClassMeta<?> cm);
044
045   /**
046    * Returns the URI for the specified class.
047    *
048    * @param cm The class.
049    * @return The URI for the specified class.
050    */
051   URI getURI(ClassMeta<?> cm);
052
053   /**
054    * Returns the URI for the specified class by its ID.
055    *
056    * @param id The class ID.
057    * @return The URI for the specified class.
058    */
059   URI getURI(String id);
060}