/**
 *
 * Copyright (c) 2014, the Railo Company Ltd. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either 
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public 
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 * 
 **/
package lucee.runtime.type;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

import lucee.commons.lang.CFTypes;
import lucee.commons.lang.ExternalizableUtil;

/**
 * a single argument of a function, this is lightway function, just contain name and type (return default value for the rest)
 */
public final class FunctionArgumentLight implements FunctionArgument,Externalizable {
	
	private static final long serialVersionUID = 817360221819952381L; // do not change
	
	
	private Collection.Key name;
	private short type;
	private String strType;
	private boolean required;
	

	
	/**
	 * NEVER USE THIS CONSTRUCTOR, this constructor is only for deserialize this object from stream
	 */
	public FunctionArgumentLight() {}

	
	public FunctionArgumentLight(Collection.Key name) {
		this(name, "any", CFTypes.TYPE_ANY);
	}

	public FunctionArgumentLight(Collection.Key name,short type) {
		this(name, CFTypes.toString(type,"any"), type);
	}

	public FunctionArgumentLight(Collection.Key name,String strType,short type) {
		this.name=name;
		this.strType=strType;
		this.type=type;
	}

	public FunctionArgumentLight(Collection.Key name,String strType,short type, boolean required) {
		this.name=name;
		this.strType=strType;
		this.type=type;
		this.required=required;
	}

	/**
	 * @return the defaultType
	 */
	@Override
	public int getDefaultType() {
		return DEFAULT_TYPE_NULL;
	}


	@Override
	public Collection.Key getName() {
		return name;
	}

	@Override
	public boolean isRequired() {
		return required;
	}

	@Override
	public short getType() {
		return type;
	}

	@Override
	public String getTypeAsString() {
		return strType;
	}

	@Override
	public String getHint() {
		return "";
	}


	@Override
	public String getDisplayName() {
		return "";
	}
	
	@Override
	public Struct getMetaData() {
		return null;
	}
	
	@Override
	public boolean isPassByReference() {
		return true;
	}


	@Override
	public void readExternal(ObjectInput in) throws IOException,ClassNotFoundException {
		name=KeyImpl.init(ExternalizableUtil.readString(in));
		type=in.readShort();
		strType=ExternalizableUtil.readString(in);
	}


	@Override
	public void writeExternal(ObjectOutput out) throws IOException {
		ExternalizableUtil.writeString(out, name.getString());
		out.writeShort(type);
		ExternalizableUtil.writeString(out, strType);
	}
	
	@Override
	public boolean equals(Object obj){
		if(!(obj instanceof FunctionArgument)) return false;
		return FunctionArgumentImpl.equals(this,(FunctionArgument)obj);
	}
}