com.strategicgains.restexpress.plugin.swagger.domain.ApiModel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of SwaggerPlugin Show documentation

RESTExpress plugin for automatic Swagger documentation

There is a newer version: 0.3.3

/*
    Copyright 2013, Strategic Gains, Inc.

	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at

		http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
 */
package com.strategicgains.restexpress.plugin.swagger.domain;

import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;

/**
 * @author toddf
 * @since Nov 21, 2013
 */
public class ApiModel
{
	private String id;
	private Set required;
	private Map properties;
	private String description;

	public String getId()
	{
		return id;
	}

	public String getDescription()
	{
		return description;
	}

	public ApiModel id(String id)
	{
		this.id = id;
		return this;
	}

	public ApiModel description(String description)
	{
		this.description = description;
		return this;
	}

	public ApiModel required(String property)
	{
		if (required == null)
		{
			required = new HashSet();
		}

		required.add(property);
		return this;
	}

	public ApiModel property(DataType property)
	{
		if (properties == null)
		{
			properties = new LinkedHashMap();
		}

		if (!properties.containsKey(property.getProperty()))
		{
			properties.put(property.getProperty(), property);
		}

		return this;
	}
}