com.github.leonidesfernando.jpa.converter.java.time.YearMonthPersistenceConverter Maven / Gradle / Ivy
/**
* Copyright (c) 2014, JPAAttributeConverters
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of JPAAttributeConverters, any associated website, nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL JPAATTRIBUTECONVERTERS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.github.leonidesfernando.jpa.converter.java.time;
import javax.persistence.AttributeConverter;
import javax.persistence.Converter;
import java.time.YearMonth;
import java.util.Objects;
/**
* Converts {@link java.time.YearMonth} to {@link String} and back
* in support of JPA persistence.
*
* The existence of this class in the classpath and it being known by the persistence unit
* is sufficient
* to allow you to use the as-of Java SE 8 {@link java.time.YearMonth} class in
* an {@link javax.persistence.Entity} or in other persistable classes.
*
* Important: the setting of @Converter(autoApply = true)
* in this class will make this conversion
* automatically effective for all Entities that have one or more
* persistent {@link java.time.YearMonth} properties.
*
* The persistence provider must minimally support
* JPA 2.1
* for this to work.
*/
@Converter(autoApply = true)
public class YearMonthPersistenceConverter implements AttributeConverter {
/**
* @return Outputs this year-month as a String, such as 2007-12. The output will be in the format uuuu-MM
* @see YearMonth#toString()
*/
@Override
public String convertToDatabaseColumn(YearMonth entityValue) {
return Objects.toString(entityValue, null);
}
@Override
public YearMonth convertToEntityAttribute(String databaseValue) {
if(databaseValue != null && !databaseValue.isEmpty()) {
return YearMonth.parse(databaseValue);
}
return null;
}
}