Merge branch 'master' of

https://github.com/JavaMoney/javamoney-extras.git

Conflicts:
	pom.xml
	src/main/java/net/java/javamoney/extras/ValidationException.java

Author: atsticks

.project

@@ -17,6 +17,7 @@
 		</buildCommand>
 	</buildSpec>
 	<natures>
+		<nature>org.eclipse.pde.PluginNature</nature>
 		<nature>org.eclipse.m2e.core.maven2Nature</nature>
 		<nature>org.eclipse.jdt.core.javanature</nature>
 	</natures>

.settings/.gitignore

@@ -0,0 +1 @@
+/org.eclipse.pde.core.prefs

pom.xml

@@ -7,9 +7,17 @@
 	<artifactId>money-extras</artifactId>
 	<name>Money and Currency - Extras not part of JSR 354</name>
 	<packaging>bundle</packaging>
+<<<<<<< HEAD
 
+=======
+
+>>>>>>> branch 'master' of https://github.com/JavaMoney/javamoney-extras.git
 	<properties>
+<<<<<<< HEAD
 	  <jdkVersion>1.7</jdkVersion>
+=======
+		<jdkVersion>1.7</jdkVersion>
+>>>>>>> branch 'master' of https://github.com/JavaMoney/javamoney-extras.git
 		<maven.compile.targetLevel>${jdkVersion}</maven.compile.targetLevel>
 		<maven.compile.sourceLevel>${jdkVersion}</maven.compile.sourceLevel>
 		<javamoney.version>0.5-SNAPSHOT</javamoney.version>
@@ -60,6 +68,14 @@
 		</plugins>
 	</build>
 	<dependencies>
+<<<<<<< HEAD
+=======
+		<dependency>
+			<groupId>javax.money</groupId>
+			<artifactId>money-ri-platform</artifactId>
+			<version>${javamoney.version}</version>
+		</dependency>
+>>>>>>> branch 'master' of https://github.com/JavaMoney/javamoney-extras.git
 		<dependency>
 			<groupId>javax.money</groupId>
 			<artifactId>money-api-convert</artifactId>

src/main/java/net/java/javamoney/extras/ValidationException.java

@@ -0,0 +1,57 @@
+/*
+ * CREDIT SUISSE IS WILLING TO LICENSE THIS SPECIFICATION TO YOU ONLY UPON THE CONDITION THAT YOU ACCEPT ALL OF THE TERMS CONTAINED IN THIS AGREEMENT. PLEASE READ THE TERMS AND CONDITIONS OF THIS AGREEMENT CAREFULLY. BY DOWNLOADING THIS SPECIFICATION, YOU ACCEPT THE TERMS AND CONDITIONS OF THE AGREEMENT. IF YOU ARE NOT WILLING TO BE BOUND BY IT, SELECT THE "DECLINE" BUTTON AT THE BOTTOM OF THIS PAGE.
+ *
+ * Specification:  JSR-354  Money and Currency API ("Specification")
+ *
+ * Copyright (c) 2012-2013, Credit Suisse
+ * All rights reserved.
+ */
+package org.javamoney.extras;
+
+import java.util.Map;
+
+/**
+ * Defines a {@link CompoundType} containing several results. Hereby the
+ * different results are identified by arbitrary keys. Additionally each
+ * {@link CompoundType} has a <i>leading</i> item that identifies the type of
+ * result.<br/>
+ * A {@link CompoundType} instance is defined to be implemented as immutable
+ * object and therefore is very useful for modeling multidimensional results
+ * objects or input parameters as they are common in financial applications.
+ * 
+ * @author Anatole Tresch
+ */
+public interface CompoundType extends Map<String, Class<?>> {
+
+	/**
+	 * A {@link CompoundType}may have a type identifier that helps to identify,
+	 * what type of items object is returned.
+	 * 
+	 * @return the {@link CompoundType}'s type, never null.
+	 */
+	public String getId();
+
+	/**
+	 * This method allows to check if a key within the {@code CompoundType} is a
+	 * required value, so a corresponding {@link CompoundValue} is valid.
+	 * 
+	 * @param key
+	 *            the key
+	 * @return true, if the corresponding value is required, false otherwise.
+	 */
+	public boolean isRequired(String key);
+
+	/**
+	 * Validates if the given {@link CompoundValue} defines all the attributes
+	 * as required by this {@link CompoundType} instance.
+	 * 
+	 * @param compundValueMap
+	 *            the {@link Map} to be validated before a {@link CompoundValue}
+	 *            is created.
+	 * @see #isValid(CompoundValue)
+	 * @throws IllegalArgumentException
+	 *             if validation fails.
+	 */
+	public void validate(Map<String, Object> compundValueMap)
+			throws ValidationException;
+}

src/main/java/org/javamoney/extras/CompoundType.java

@@ -0,0 +1,41 @@
+/*
+ * CREDIT SUISSE IS WILLING TO LICENSE THIS SPECIFICATION TO YOU ONLY UPON THE CONDITION THAT YOU ACCEPT ALL OF THE TERMS CONTAINED IN THIS AGREEMENT. PLEASE READ THE TERMS AND CONDITIONS OF THIS AGREEMENT CAREFULLY. BY DOWNLOADING THIS SPECIFICATION, YOU ACCEPT THE TERMS AND CONDITIONS OF THE AGREEMENT. IF YOU ARE NOT WILLING TO BE BOUND BY IT, SELECT THE "DECLINE" BUTTON AT THE BOTTOM OF THIS PAGE.
+ *
+ * Specification:  JSR-354  Money and Currency API ("Specification")
+ *
+ * Copyright (c) 2012-2013, Credit Suisse
+ * All rights reserved.
+ */
+package org.javamoney.extras;
+
+import java.util.Map;
+
+/**
+ * Defines a {@link CompoundValue} containing several results. Hereby the
+ * different results are identified by arbitrary keys. Additionally each
+ * {@link CompoundValue} has a <i>leading</i> item that identifies the type of
+ * result.<br/>
+ * A {@link CompoundValue} instance is defined to be implemented as immutable
+ * object and therefore is very useful for modeling multidimensional results
+ * objects or input parameters as they are common in financial applications.
+ * 
+ * @author Anatole Tresch
+ */
+public interface CompoundValue extends Map<String,Object>{
+
+	/**
+	 * A {@link CompoundValue} may have an identifier that helps to identify,
+	 * what type of items object is returned.
+	 * 
+	 * @return the {@link CompoundValue}'s type, never null.
+	 */
+	public String getId();
+
+	/**
+	 * Get the compound type of this instance.
+	 * 
+	 * @return the compound type, never {@code null}.
+	 */
+	public CompoundType getCompoundType();
+	
+}

src/main/java/org/javamoney/extras/CompoundValue.java

@@ -0,0 +1,169 @@
+/*
+ *  Copyright (c) 2012, 2013, Werner Keil, Credit Suisse (Anatole Tresch).
+ *
+ *  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.
+ *
+ * Contributors:
+ *    Anatole Tresch - initial version.
+ */
+package org.javamoney.extras;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Defines a {@link MultiValue} containing T instances.
+ * 
+ * @see CompoundValue
+ * @author Anatole Tresch
+ */
+public class MultiValue extends HashMap<String, Object> implements
+		CompoundValue {
+
+	/**
+	 * serialVersionUID.
+	 */
+	private static final long serialVersionUID = 5511830637352838197L;
+	private final String id;
+	private CompoundType type;
+
+	protected MultiValue(String id, CompoundType type) {
+		if (id == null) {
+			throw new IllegalArgumentException("id can not bve null.");
+		}
+		this.id = id;
+		if (type == null) {
+			throw new IllegalArgumentException("type can not bve null.");
+		}
+		this.type = type;
+	}
+
+	protected MultiValue(String id, CompoundType type, Map<String, Object> items) {
+		this(id, type);
+		type.validate(items);
+		this.putAll(items);
+	}
+
+	public CompoundType getCompoundType() {
+		return this.type;
+	}
+
+	/**
+	 * A compound item may have a type identifier that helps to identify, what
+	 * type of compound items object is returned.
+	 * 
+	 * @return the compound item's type, never null.
+	 */
+	public String getId() {
+		return this.id;
+	}
+
+	public Builder toBuilder() {
+		return new Builder(this);
+	}
+
+	/**
+	 * A CompoundItemBuilder T is an CompoundItemBuilder that holds several
+	 * instances of a type T. In financial applications this is very useful
+	 * regarding several aspects:<br/>
+	 * <li>Passing several instance of T as one parameter into methods <li>
+	 * Returning several instance of T as result, e.g. from a complex financial
+	 * calculation. <li>Accessing series of data, e.g. by time or other
+	 * classification. <li>
+	 * Accessing multiple data from different providers.
+	 * 
+	 * 
+	 * @author Anatole Tresch
+	 */
+	public static class Builder {
+
+		private String id;
+		private CompoundType type;
+		private Map<String, Object> items = new HashMap<String, Object>();
+
+		public Builder(String id) {
+			setId(id);
+		}
+
+		public Builder(String id, CompoundType type) {
+			setId(id);
+			setCompoundType(type);
+		}
+
+		public Builder setCompoundType(CompoundType type) {
+			if (type == null) {
+				throw new IllegalArgumentException("Compound type required.");
+			}
+			this.type = type;
+			return this;
+		}
+
+		public CompoundType getCompoundType() {
+			return this.type;
+		}
+
+		public Builder(CompoundValue baseItem) {
+			if (baseItem != null) {
+				setId(baseItem.getId());
+				this.items.putAll(baseItem);
+			}
+		}
+
+		public String getId() {
+			return this.id;
+		}
+
+		public Builder setId(String id) {
+			if (id == null) {
+				throw new IllegalArgumentException("id may not be null.");
+			}
+			this.id = id;
+			return this;
+		}
+
+		public Map<String, Object> getItems() {
+			return this.items;
+		}
+
+		public Object set(String key, Object item) {
+			if (item == null) {
+				throw new IllegalArgumentException("item may not be null.");
+			}
+			if (key == null) {
+				throw new IllegalArgumentException("key may not be null.");
+			}
+			return this.items.put(key, item);
+		}
+
+		public void set(Map<String, Object> items) {
+			if (items == null) {
+				throw new IllegalArgumentException("items may not be null.");
+			}
+			this.items.putAll(items);
+		}
+
+		public Object remove(Object key) {
+			return this.items.remove(key);
+		}
+
+		public void removeAll() {
+			this.items.clear();
+		}
+
+		public CompoundValue build() {
+			return new MultiValue(this.id, this.type, this.items);
+		}
+
+	}
+
+}