org.javamoney.moneta.function.MonetaryQueries Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of moneta-bp Show documentation

JSR 354 provides an API for representing, transporting, and performing comprehensive calculations with Money and Currency. This module implements JSR 354.

There is a newer version: 1.4.1

Show newest version

/*
 * Copyright (c) 2012, 2014, Credit Suisse (Anatole Tresch), Werner Keil and others by the @author tag.
 *
 * 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.
 */
package org.javamoney.moneta.function;

import javax.money.MonetaryAmount;
import javax.money.MonetaryQuery;

/**
 * This class has utility queries, {@link MonetaryQuery}, to {@link MonetaryAmount}.
 *
 * {@code
 * 	MonetaryAmount monetaryAmount = Money.parse("EUR 2.35");
 * 	Long result = monetaryAmount.query(query);// 2L
 * }
 *  Or using:
 * {@code
 * 	MonetaryAmount monetaryAmount = Money.parse("EUR 2.35");
 * 	Long result = query.queryFrom(monetaryAmount);// 2L
 * }
 * @see MonetaryAmount#query(MonetaryQuery)
 * @see MonetaryQuery
 * @see MonetaryQuery#queryFrom(MonetaryAmount)
 * @author Otavio Santana
 * @since 1.0.1
 */
public final class MonetaryQueries {

	private static final ExtractorMajorPartQuery EXTRACTOR_MAJOR_PART = new ExtractorMajorPartQuery();

	private static final ConvertMinorPartQuery CONVERT_MINOR_PART = new ConvertMinorPartQuery();

	private static final ExtractorMinorPartQuery EXTRACTOR_MINOR_PART = new ExtractorMinorPartQuery();

	private MonetaryQueries() {
	}

	/**
	 * Allows to extract the major part of a {@link MonetaryAmount} instance.
	 * Gets the amount in major units as a {@code long}.
	 *
	 * For example, 'EUR 2.35' will return 2, and 'BHD -1.345' will return -1.
	 *
	 * { @code
	 * 	MonetaryAmount monetaryAmount = Money.parse("EUR 2.35");
	 * 	Long result = monetaryAmount.query(MonetaryQueries.majorPart());// 2L
	 * }
	 */
	public static MonetaryQuery extractMajorPart() {
		return EXTRACTOR_MAJOR_PART;
	}

	/**
	 * Convert to minor part a {@link MonetaryAmount} instance.
	 *
	 * This returns the monetary amount in terms of the minor units of the
	 * currency, truncating the amount if necessary. For example, 'EUR 2.35'
	 * will return 235, and 'BHD -1.345' will return -1345.
	 *
	 * {@code
	 * 	MonetaryAmount monetaryAmount = Money.parse("EUR 2.35");
	 * 	Long result = monetaryAmount.query(MonetaryQueries.convertMinorPart());// 235L
	 * }
	 */
	public static MonetaryQuery convertMinorPart() {
		return CONVERT_MINOR_PART;
	}

	/**
	 * Convert to minor part a {@link MonetaryAmount} instance.
	 *
	 * This returns the monetary amount in terms of the minor units of the
	 * currency, truncating the whole part if necessary. For example, 'EUR 2.35'
	 * will return 35, and 'BHD -1.345' will return -345.
	 *
	 *
	 * {@code
	 * 	MonetaryAmount monetaryAmount = Money.parse("EUR 2.35");
	 * 	Long result = monetaryAmount.query(MonetaryQueries.convertMinorPart());// 35L
	 * }
	 */
	public static MonetaryQuery extractMinorPart() {
		return EXTRACTOR_MINOR_PART;
	}
}