EntityGraphType.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.deltaspike.data.api;

/**
 * Entity graph type (fetch graph or load graph). The type determines
 * the query hint name used to pass the entity graph to a query.
 */
public enum EntityGraphType
{
    /** Fetch graph. */
    FETCH("javax.persistence.fetchgraph"),

    /** Load graph. */
    LOAD("javax.persistence.loadgraph");
    
    private String hintName;
    
    private EntityGraphType(String hintName)
    {
        this.hintName = hintName;
    }
    
    /**
     * Gets the query hint name corresponding to this type.
     * @return hint name
     */
    public String getHintName()
    {
        return hintName;
    }
}