org.springframework.batch.core.jsr.SimpleMetric Maven / Gradle / Ivy

/*
 * Copyright 2013 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.batch.core.jsr;

import javax.batch.runtime.Metric;

import org.springframework.util.Assert;

/**
 * Simple implementation of the {@link Metric} interface as required by JSR-352.
 *
 * @author Michael Minella
 * @since 3.0
 */
public class SimpleMetric implements Metric {

	private final MetricType type;
	private final long value;

	/**
	 * Basic constructor.  The attributes are immutable so this class is
	 * thread-safe.
	 *
	 * @param type as defined by JSR-352
	 * @param value the count of the times the related type has occurred.
	 */
	public SimpleMetric(MetricType type, long value) {
		Assert.notNull(type, "A MetricType is required");

		this.type = type;
		this.value = value;
	}

	/* (non-Javadoc)
	 * @see javax.batch.runtime.Metric#getType()
	 */
	@Override
	public MetricType getType() {
		return type;
	}

	/* (non-Javadoc)
	 * @see javax.batch.runtime.Metric#getValue()
	 */
	@Override
	public long getValue() {
		return value;
	}

}