/* * Copyright 2013 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 * * 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.github.geequery.springdata.repository.query; import java.lang.reflect.Method; import java.util.Date; import java.util.List; import javax.persistence.TemporalType; import org.springframework.core.MethodParameter; import org.springframework.data.repository.query.Parameter; import org.springframework.data.repository.query.Parameters; import com.github.geequery.springdata.annotation.IgnoreIf; import com.github.geequery.springdata.annotation.Temporal; import com.github.geequery.springdata.repository.query.GqParameters.GqParameter; /** * Custom extension of {@link Parameters} discovering additional query parameter * annotations. * * @author Thomas Darimont */ public class GqParameters extends Parameters<GqParameters, GqParameter> { /** * Creates a new {@link GqParameters} instance from the given {@link Method} * . * * @param method * must not be {@literal null}. */ public GqParameters(Method method) { super(method); } private GqParameters(List<GqParameter> parameters) { super(parameters); } /* * (non-Javadoc) * * @see * org.springframework.data.repository.query.Parameters#createParameter( * org.springframework.core.MethodParameter) */ @Override protected GqParameter createParameter(MethodParameter parameter) { return new GqParameter(parameter); } /* * (non-Javadoc) * * @see * org.springframework.data.repository.query.Parameters#createFrom(java. * util.List) */ @Override protected GqParameters createFrom(List<GqParameter> parameters) { return new GqParameters(parameters); } /** * Custom {@link Parameter} implementation adding parameters of type * {@link Temporal} to the special ones. * * @author Thomas Darimont * @author Oliver Gierke */ static class GqParameter extends Parameter { private final Temporal annotation; private TemporalType temporalType; private IgnoreIf ignoreIf; /** * Creates a new {@link GqParameter}. * * @param parameter * must not be {@literal null}. */ GqParameter(MethodParameter parameter) { super(parameter); this.annotation = parameter.getParameterAnnotation(Temporal.class); this.ignoreIf = parameter.getParameterAnnotation(IgnoreIf.class); this.temporalType = null; if (!isDateParameter() && hasTemporalParamAnnotation()) { throw new IllegalArgumentException(Temporal.class.getSimpleName() + " annotation is only allowed on Date parameter!"); } } /* * (non-Javadoc) * * @see org.springframework.data.repository.query.Parameter#isBindable() */ @Override public boolean isBindable() { return super.isBindable() || isTemporalParameter(); } /** * @return {@literal true} if this parameter is of type {@link Date} and * has an {@link Temporal} annotation. */ public boolean isTemporalParameter() { return isDateParameter() && hasTemporalParamAnnotation(); } /** * @return the {@link TemporalType} on the {@link Temporal} annotation * of the given {@link Parameter}. */ public TemporalType getTemporalType() { if (temporalType == null) { this.temporalType = annotation == null ? null : annotation.value(); } return this.temporalType; } private boolean hasTemporalParamAnnotation() { return annotation != null; } private boolean isDateParameter() { return getType().equals(Date.class); } public IgnoreIf getIgnoreIf() { return ignoreIf; } } }