graphql.schema.GraphQLDirectiveContainer Maven / Gradle / Ivy
package graphql.schema;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import graphql.PublicApi;
import java.util.List;
import java.util.Map;
import static graphql.DirectivesUtil.allDirectivesByName;
import static graphql.DirectivesUtil.nonRepeatableDirectivesByName;
import static graphql.DirectivesUtil.nonRepeatedDirectiveByNameWithAssert;
import static java.util.Collections.emptyList;
/**
* Represents a graphql runtime type that can have {@link graphql.schema.GraphQLDirective}'s.
*
* Directives can be repeatable and (by default) non repeatable.
*
* There are access methods here that get the two different types.
*
* @see graphql.language.DirectiveDefinition
* @see graphql.language.DirectiveDefinition#isRepeatable()
*/
@PublicApi
public interface GraphQLDirectiveContainer extends GraphQLNamedSchemaElement {
/**
* This will return a list of all the directives that have been put on {@link graphql.schema.GraphQLNamedSchemaElement} as a flat list, which may contain repeatable
* and non repeatable directives.
*
* @return a list of all the directives associated with this named schema element
*/
List getDirectives();
/**
* This will return a Map of the non repeatable directives that are associated with a {@link graphql.schema.GraphQLNamedSchemaElement}. Any repeatable directives
* will be filtered out of this map.
*
* @return a map of non repeatable directives by directive name.
*/
Map getDirectivesByName();
/**
* This will return a Map of the all directives that are associated with a {@link graphql.schema.GraphQLNamedSchemaElement}, including both
* repeatable and non repeatable directives.
*
* @return a map of all directives by directive name
*/
Map> getAllDirectivesByName();
/**
* Returns a non repeatable directive with the provided name. This will throw a {@link graphql.AssertException} if
* the directive is a repeatable directive that has more then one instance.
*
* @param directiveName the name of the directive to retrieve
*
* @return the directive or null if there is not one with that name
*/
GraphQLDirective getDirective(String directiveName);
/**
* Returns all of the directives with the provided name, including repeatable and non repeatable directives.
*
* @param directiveName the name of the directives to retrieve
*
* @return the directives or empty list if there is not one with that name
*/
default List getDirectives(String directiveName) {
return getAllDirectivesByName().getOrDefault(directiveName, emptyList());
}
}