org.ff4j.property.PropertyInstant Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ff4j-core Show documentation
The newest version!
package org.ff4j.property;

/*-
 * #%L
 * ff4j-core
 * %%
 * Copyright (C) 2013 - 2024 FF4J
 * %%
 * 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.
 * #L%
 */

import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneOffset;
import java.time.format.DateTimeFormatter;

/**
 * Creatoin of property.
 *
 * @author Cedrick LUNVEN (@clunven)
 */
public class PropertyInstant extends Property< Instant > {

    /** serialVersionUID. */
    private static final long serialVersionUID = -620523134883483837L;
    
    /** formatter for creation date and last modified. */
    protected static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSS");
    
    /** zone offset. */
    protected ZoneOffset zone = ZoneOffset.UTC;

    /**
     * Constructor by property name.
     *
     * @param name
     *      property name
     */
    public PropertyInstant(String name) {
        super(name);
    }
    
    /**
     * Constructor by string expression.
     *
     * @param uid
     *      unique name
     * @param lvl
     *      current log level
     */
    public PropertyInstant(String uid, String value) {
       super(uid, value);
    }
    
    /**
     * Constructor by string expression.
     *
     * @param uid
     *      unique name
     * @param lvl
     *      current log level
     */
    public PropertyInstant(String uid, Instant date) {
       super(uid, date);
    }    

    public LocalDateTime toLocalDateTime() {
        return LocalDateTime.ofInstant(value, zone);
    }
    
    /** 
     * Serialized value as String
     *
     * @return
     *      current value as a string or null
     */
    public String asString() {
        if (value == null) return null;
        return toLocalDateTime().format(FORMATTER);
    }
    
    /** {@inheritDoc} */
    @Override
    public Instant fromString(String v) {
        return LocalDateTime.parse(v, FORMATTER).toInstant(zone);
    }

    /**
     * Getter accessor for attribute 'zone'.
     *
     * @return
     *       current value of 'zone'
     */
    public ZoneOffset getZone() {
        return zone;
    }

    /**
     * Setter accessor for attribute 'zone'.
     * @param zone
     * 		new value for 'zone '
     */
    public void setZone(ZoneOffset zone) {
        this.zone = zone;
    }

}