blob: 944c34b89f5426ea86ac502a97534433c4a4b9a5 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.opensymphony.xwork2.config.entities;
import com.opensymphony.xwork2.util.location.Located;
import com.opensymphony.xwork2.util.location.Location;
import java.io.Serializable;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
/**
* Configuration class for result types.
*
* <p>
* In the xml configuration file this is defined as the <code>result-type</code> tag.
* </p>
*
* @author Mike
* @author Rainer Hermanns
* @author Neo
*/
public class ResultTypeConfig extends Located implements Serializable {
protected String className;
protected String name;
protected String defaultResultParam;
protected Map<String,String> params;
protected ResultTypeConfig(String name, String className) {
this.name = name;
this.className = className;
params = new LinkedHashMap<>();
}
protected ResultTypeConfig(ResultTypeConfig orig) {
this.name = orig.name;
this.className = orig.className;
this.defaultResultParam = orig.defaultResultParam;
this.params = new LinkedHashMap<>(orig.params);
this.location = orig.location;
}
public String getDefaultResultParam() {
return this.defaultResultParam;
}
public String getClassName() {
return className;
}
public String getName() {
return name;
}
public Map<String,String> getParams() {
return Collections.unmodifiableMap(this.params);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
final ResultTypeConfig that = (ResultTypeConfig) o;
if (className != null ? !className.equals(that.className) : that.className != null) return false;
if (name != null ? !name.equals(that.name) : that.name != null) return false;
if (params != null ? !params.equals(that.params) : that.params != null) return false;
return true;
}
@Override
public int hashCode() {
int result;
result = (className != null ? className.hashCode() : 0);
result = 29 * result + (name != null ? name.hashCode() : 0);
result = 29 * result + (params != null ? params.hashCode() : 0);
return result;
}
@Override
public String toString() {
return "ResultTypeConfig: [" + name + "] => [" + className + "] " +
"with defaultParam [" + defaultResultParam + "] with params " + params;
}
/**
* The builder for this object. An instance of this object is the only way to construct a new instance. The
* purpose is to enforce the immutability of the object. The methods are structured in a way to support chaining.
* After setting any values you need, call the {@link #build()} method to create the object.
*/
public static final class Builder {
protected ResultTypeConfig target;
public Builder(String name, String className) {
target = new ResultTypeConfig(name, className);
}
public Builder(ResultTypeConfig orig) {
target = new ResultTypeConfig(orig);
}
public Builder name(String name) {
target.name = name;
return this;
}
public Builder className(String name) {
target.className = name;
return this;
}
public Builder addParam(String name, String value) {
target.params.put(name, value);
return this;
}
public Builder addParams(Map<String,String> params) {
target.params.putAll(params);
return this;
}
public Builder defaultResultParam(String defaultResultParam) {
target.defaultResultParam = defaultResultParam;
return this;
}
public Builder location(Location loc) {
target.location = loc;
return this;
}
public ResultTypeConfig build() {
ResultTypeConfig result = target;
target = new ResultTypeConfig(target);
return result;
}
}
}