org.springframework.data.cassandra.core.mapping.Tuple Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-cassandra Show documentation

Cassandra support for Spring Data

There is a newer version: 4.3.2

Show newest version

/*
 * Copyright 2018-2024 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.data.cassandra.core.mapping;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Identifies a domain object as Cassandra Tuple. Tuples use ordered fields to map their value to the actual property.
 * 
 * A mapped tuple type is typically annotated with {@code @Tuple} and its properties/accessors are annotated with
 * {@code @Element(0), @Element(1), ..., @Element(n)}.
 * 

 * Example usage:
 *
 * 
 * @Tuple
 * class Address {
 *
 * 	@Element(0) String street;
 *
 * 	@Element(1) @CassandraType(type = Name.ASCII) String city;
 *
 * 	@Element(2) int sortOrder;
 * }
 * 
 *
 * @author Mark Paluch
 * @since 2.1
 * @see Element
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE })
public @interface Tuple {
}