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.bean.jsonschema;
018
019import java.net.*;
020
021import org.apache.juneau.marshall.*;
022
023
024/**
025 * Convenience class for representing a schema reference such as <js>"{'$ref':'/url/to/ref'}"</js>.
026 *
027 * <p>
028 * An instance of this object is equivalent to calling...
029 *
030 * <p class='bjava'>
031 *    JsonSchema <jv>schema</jv> = <jk>new</jk> JsonSchema().setRef(<jv>uri</jv>);
032 * </p>
033 */
034public class JsonSchemaRef extends JsonSchema<JsonSchemaRef> {
035
036   /**
037    * Constructor.
038    *
039    * <p>
040    * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
041    * Strings must be valid URIs.
042    *
043    * <p>
044    * URIs defined by {@link UriResolver} can be used for values.
045    *
046    * @param uri The URI of the target reference.  Can be <jk>null</jk> to leave the property unset.
047    */
048   public JsonSchemaRef(Object uri) {
049      this.setRef(uri);
050   }
051}