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