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
015/**
016 * Convenience class for representing a property that's an array of simple types.
017 *
018 * <p>
019 * An instance of this object is equivalent to calling...
020 *
021 * <p class='bcode w800'>
022 *    JsonSchemaProperty p = <jk>new</jk> JsonSchemaProperty(name)
023 *       .setType(JsonType.<jsf>ARRAY</jsf>)
024 *       .setItems(
025 *          <jk>new</jk> JsonSchema().setType(elementType)
026 *       );
027 * </p>
028 *
029 * <h5 class='section'>See Also:</h5>
030 * <ul class='doctree'>
031 *    <li class='jp'>{@doc package-summary.html#TOC org.apache.juneau.dto.jsonschema}
032 * </ul>
033 */
034public class JsonSchemaPropertySimpleArray extends JsonSchemaProperty {
035
036   /**
037    * Constructor.
038    *
039    * @param name The name of the schema property.
040    * @param elementType The JSON type of the elements in the array.
041    */
042   public JsonSchemaPropertySimpleArray(String name, JsonType elementType) {
043      setName(name);
044      setType(JsonType.ARRAY);
045      setItems(
046         new JsonSchema().setType(elementType)
047      );
048   }
049}