com.netflix.hollow.api.consumer.index.FieldPath Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hollow Show documentation

hollow

There is a newer version: 7.14.3

/*
 *  Copyright 2016-2019 Netflix, Inc.
 *
 *     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 com.netflix.hollow.api.consumer.index;

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

/**
 * A field path associated with a field or method declaration whose type or
 * return type respectively is associated resolution of the field path.
 *
 * @see com.netflix.hollow.core.index.FieldPaths
 */
@Retention(RetentionPolicy.RUNTIME)
@Target( {ElementType.FIELD, ElementType.METHOD}) public @interface FieldPath {
    /**
     * @return the field path, if empty then the path is derived from the field or method name.
     */
    String value() default "";

    /**
     * @return the field path order
     */
    int order() default 0;
}