com.blazebit.query.spi.MapDataFormat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blaze-query-core-api Show documentation

A multi-platform querying library

The newest version!

/*
 * SPDX-License-Identifier: Apache-2.0
 * Copyright Blazebit
 */
package com.blazebit.query.spi;

import java.lang.reflect.Type;
import java.util.Collections;
import java.util.List;

/**
 * An object that describes the data format of a map type.
 *
 * @author Christian Beikov
 * @since 1.0.0
 */
public interface MapDataFormat extends DataFormat {

	/**
	 * Returns the Java type for this format.
	 *
	 * @return the Java type for this format
	 */
	Type getType();

	/**
	 * Returns the format of the map key.
	 *
	 * @return the format of the map key
	 */
	DataFormat getKeyFormat();

	/**
	 * Returns the format of the map element.
	 *
	 * @return the format of the map element
	 */
	DataFormat getElementFormat();

	/**
	 * Returns a new map data format.
	 *
	 * @param type The collection type
	 * @param keyFormat The key format
	 * @param elementFormat The element format
	 * @return the map data format
	 */
	static MapDataFormat of(Type type, DataFormat keyFormat, DataFormat elementFormat) {
		return new MapDataFormat() {
			@Override
			public Type getType() {
				return type;
			}

			@Override
			public List getFields() {
				return Collections.emptyList();
			}

			@Override
			public DataFormat getKeyFormat() {
				return keyFormat;
			}

			@Override
			public DataFormat getElementFormat() {
				return elementFormat;
			}
		};
	}

}