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 */
022public interface BeanDefMapper {
023
024   /**
025    * Represents the absence of a bean definition mapper class.
026    */
027   public interface Null extends BeanDefMapper {}
028
029   /**
030    * Returns the ID for the specified class.
031    *
032    * @param cm The class.
033    * @return The ID for the specified class.
034    */
035   String getId(ClassMeta<?> cm);
036
037   /**
038    * Returns the URI for the specified class.
039    *
040    * @param cm The class.
041    * @return The URI for the specified class.
042    */
043   URI getURI(ClassMeta<?> cm);
044
045   /**
046    * Returns the URI for the specified class by its ID.
047    *
048    * @param id The class ID.
049    * @return The URI for the specified class.
050    */
051   URI getURI(String id);
052}