org.jbasics.command.CommandParameter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbasics Show documentation
jBasics is a collection of useful utility classes for Java. This includes helper for XML, mathematic functions, restful web services helper, pattern oriented programming interfaces and more. Currently Java7 and up is supported. Version 1.0 will required at leaset Java8.
There is a newer version: 2.0.0p3
Show newest version
/*
 * Copyright (c) 2009-2015
 * 	IT-Consulting Stephan Schloepke (http://www.schloepke.de/)
 * 	klemm software consulting Mirko Klemm (http://www.klemm-scs.com/)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.jbasics.command;

import org.jbasics.checker.ContractCheck;
import org.jbasics.configuration.properties.DateValueTypeFactory;
import org.jbasics.configuration.properties.DurationValueTypeFactory;
import org.jbasics.pattern.factory.ParameterFactory;
import org.jbasics.pattern.modifer.Concatable;
import org.jbasics.pattern.modifer.Extendable;
import org.jbasics.text.StringUtilities;
import org.jbasics.types.factories.ValueOfStringTypeFactory;
import org.jbasics.types.sequences.Sequence;
import org.jbasics.utilities.DataUtilities;
import org.jbasics.xml.XMLDateConverter;

import javax.xml.datatype.Duration;
import javax.xml.datatype.XMLGregorianCalendar;
import java.io.File;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.List;

public class CommandParameter implements Extendable, Concatable {
	private final String parameterName;
	private final Sequence values;

	public CommandParameter(final String parameterName, final String value) {
		this.parameterName = ContractCheck.mustNotBeNullOrTrimmedEmpty(parameterName, "parameterName"); //$NON-NLS-1$
		this.values = new Sequence(ContractCheck.mustNotBeNull(value, "value")); //$NON-NLS-1$
	}

	public CommandParameter(final String parameterName, final String... values) {
		this.parameterName = ContractCheck.mustNotBeNullOrTrimmedEmpty(parameterName, "parameterName"); //$NON-NLS-1$
		this.values = Sequence.cons(ContractCheck.mustNotBeNullOrEmpty(values, "values")); //$NON-NLS-1$
	}

	public CommandParameter(final String parameterName, final Collection values) {
		this.parameterName = ContractCheck.mustNotBeNullOrTrimmedEmpty(parameterName, "parameterName"); //$NON-NLS-1$
		this.values = Sequence.cons(ContractCheck.mustNotBeNullOrEmpty(values, "values")); //$NON-NLS-1$
	}

	private CommandParameter(final String parameterName, final Sequence values) {
		this.parameterName = ContractCheck.mustNotBeNullOrTrimmedEmpty(parameterName, "parameterName"); //$NON-NLS-1$
		this.values = ContractCheck.mustNotBeNull(values, "values"); //$NON-NLS-1$
	}

	public static CommandParameter parse(final String input) {
		final String[] nameValuesPair = ContractCheck.mustNotBeNullOrTrimmedEmpty(input, "input").split("=", 2); //$NON-NLS-1$ //$NON-NLS-2$
		final String name = nameValuesPair[0];
		return CommandParameter.parseContent(name, nameValuesPair[1]);
	}

	public static CommandParameter parseContent(final String name, final String unparsedValue) {
		return new CommandParameter(ContractCheck.mustNotBeNullOrTrimmedEmpty(name, "name"), DataUtilities.coalesce(unparsedValue, "").split(",|;"));
	}

	public String getParameterName() {
		return this.parameterName;
	}

	public Sequence getValues() {
		return this.values;
	}

	@Override
	public CommandParameter extend(final String... addValues) {
		return new CommandParameter(this.parameterName, Sequence.cons(this.values, addValues));
	}

	@Override
	public CommandParameter concat(final CommandParameter other) {
		return new CommandParameter(this.parameterName, this.values.concat(other.values));
	}

	public CommandParameter mustBeSingle() {
		if (this.values.size() != 1) {
			throw new IllegalArgumentException("Command parameter " + this.parameterName //$NON-NLS-1$
					+ " must be a single value"); //$NON-NLS-1$
		}
		return this;
	}

	public CommandParameter mustBeOfSize(final int size) {
		if (this.values.size() != 1) {
			throw new IllegalArgumentException("Command parameter " + this.parameterName //$NON-NLS-1$
					+ " must be exactly " + size + " values"); //$NON-NLS-1$ //$NON-NLS-2$
		}
		return this;
	}

	public CommandParameter mustBeMultipleOf(final int blockSize) {
		if (this.values.size() % blockSize != 0) {
			throw new IllegalArgumentException("Command parameter " + this.parameterName //$NON-NLS-1$
					+ " must be a multiple of " + blockSize + "values"); //$NON-NLS-1$ //$NON-NLS-2$
		}
		return this;
	}

	public String asString() {
		return this.values.first();
	}

	public List asStrings() {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(value);
		}
		return Collections.unmodifiableList(result);
	}

	public Boolean asBoolean() {
		return Boolean.valueOf(this.values.first());
	}

	public List asBooleans() {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(Boolean.valueOf(value));
		}
		return Collections.unmodifiableList(result);
	}

	public Integer asInteger() {
		return Integer.decode(this.values.first());
	}

	public List asIntegers() {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(Integer.decode(value));
		}
		return Collections.unmodifiableList(result);
	}

	public Double asDouble() {
		return Double.valueOf(this.values.first());
	}

	public List asDoubles() {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(Double.valueOf(value));
		}
		return Collections.unmodifiableList(result);
	}

	public BigInteger asBigInteger() {
		return new BigInteger(this.values.first());
	}

	public List asBigIntegers() {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(new BigInteger(value));
		}
		return Collections.unmodifiableList(result);
	}

	public BigDecimal asBigDecimal() {
		return new BigDecimal(this.values.first());
	}

	public List asBigDecimals() {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(new BigDecimal(value));
		}
		return Collections.unmodifiableList(result);
	}

	public Date asDate() {
		return XMLDateConverter.convert(DateValueTypeFactory.SHARED_INSTANCE.create(this.values.first()));
	}

	public List asDates() {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(XMLDateConverter.convert(DateValueTypeFactory.SHARED_INSTANCE.create(value)));
		}
		return Collections.unmodifiableList(result);
	}

	public XMLGregorianCalendar asXmlDate() {
		return DateValueTypeFactory.SHARED_INSTANCE.create(this.values.first());
	}

	public List asXmlDates() {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(DateValueTypeFactory.SHARED_INSTANCE.create(value));
		}
		return Collections.unmodifiableList(result);
	}

	public Duration asDuration() {
		return DurationValueTypeFactory.SHARED_INSTANCE.create(this.values.first());
	}

	public List asDurations() {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(DurationValueTypeFactory.SHARED_INSTANCE.create(value));
		}
		return Collections.unmodifiableList(result);
	}

	public URI asURI() {
		return URI.create(this.values.first());
	}

	public List asURIs() {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(URI.create(value));
		}
		return Collections.unmodifiableList(result);
	}

	public > T asEnum(final Class enumType) {
		return Enum.valueOf(enumType, this.values.first());
	}

	public > List asEnums(final Class enumType) {
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(Enum.valueOf(enumType, value));
		}
		return Collections.unmodifiableList(result);
	}

	public File asFile() {
		return new File(this.values.first());
	}

	public List asFiles() {
		if (this.values.isEmpty()) {
			return Collections.emptyList();
		}
		final List files = new ArrayList();
		for (final String value : this.values) {
			final String[] temp = value.split("@", 2); //$NON-NLS-1$
			File dir = null;
			CommandFileFilter filter = null;
			if (temp.length == 2) {
				dir = new File(temp[0]);
				filter = new CommandFileFilter(temp[1], true);
			} else {
				final File t = new File(value);
				dir = new File(t.getAbsolutePath()).getParentFile();
				filter = new CommandFileFilter(t.getName(), false);
			}
			final File[] filteredFiles = dir.listFiles(filter);
			if (filteredFiles != null && filteredFiles.length > 0) {
				files.addAll(Arrays.asList(filteredFiles));
			}
		}
		return files;
	}

	public  T asStaticValueOfMethodValue(final Class type) {
		return asFactoryCreatedValue(ValueOfStringTypeFactory.getFactoryFor(type));
	}

	public  T asFactoryCreatedValue(final ParameterFactory factory) {
		return ContractCheck.mustNotBeNull(factory, "factory").create(this.values.first());
	}

	public  List asStaticValueOfMethodValues(final Class type) {
		return asFactoryCreatedValues(ValueOfStringTypeFactory.getFactoryFor(type));
	}

	public  List asFactoryCreatedValues(final ParameterFactory factory) {
		ContractCheck.mustNotBeNull(factory, "factory");
		final List result = new ArrayList(this.values.size());
		for (final String value : this.values) {
			result.add(factory.create(value));
		}
		return Collections.unmodifiableList(result);
	}

	@Override
	@SuppressWarnings("nls")
	public String toString() {
		return new StringBuilder(this.parameterName).append("=").append(StringUtilities.joinToString(",", this.values)).toString();
	}
}