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