SParameter.java

package org.bimserver.shared.meta;

/******************************************************************************
 * Copyright (C) 2009-2014  BIMserver.org
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *****************************************************************************/

import java.util.List;
import java.util.Set;

import org.codehaus.jettison.json.JSONException;
import org.codehaus.jettison.json.JSONObject;

public class SParameter {

	private final String name;
	private final SClass type;
	private final SClass genericType;
	private final SMethod sMethod;
	private String doc = "";

	public SParameter(SMethod sMethod, SClass type, SClass genericType, String name) {
		this.sMethod = sMethod;
		if (type == null) {
			throw new RuntimeException("Type cannot be null " + sMethod.getName() + "." + name);
		}
		this.type = type;
		this.genericType = genericType;
		this.name = name;
	}

	public SClass getType() {
		return type;
	}

	public String getName() {
		return name;
	}
	
	public SClass getGenericType() {
		return genericType;
	}
	
	public SClass getBestType() {
		return genericType != null ? genericType : type;
	}

	public boolean isAggregate() {
		return type.getInstanceClass().isAssignableFrom(List.class) || type.getInstanceClass().isAssignableFrom(Set.class);
	}

	public boolean isLast() {
		return sMethod.getParameter(sMethod.getParameters().size() - 1) == this;
	}

	public String getPrintableName() {
		String r = getType().getPrintableName();
		if (getGenericType() != null) {
			r += "<" + getGenericType().getPrintableName() + ">";
		}
		return r;
	}

	public void setDoc(String doc) {
		this.doc = doc.trim();
	}
	
	public String getDoc() {
		return doc;
	}

	public JSONObject toJson() throws JSONException {
		JSONObject parameterJson = new JSONObject();
		parameterJson.put("name", getName());
		parameterJson.put("doc", getDoc());
		parameterJson.put("type", getType().toJson());
		return parameterJson;
	}
}