001/*
002 * JDrupes Builder
003 * Copyright (C) 2025 Michael N. Lipp
004 * 
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.builder.api;
020
021import java.time.Instant;
022import java.time.ZoneId;
023import java.time.format.DateTimeFormatter;
024
025/// Represents a resource handled by the builder.
026///
027@SuppressWarnings("PMD.ImplicitFunctionalInterface")
028public interface Resource {
029
030    /// The instant at which this resource was created or last modified.
031    ///
032    /// @return the instant
033    ///
034    default Instant asOf() {
035        return Instant.MIN;
036    }
037
038    /// Returns the type of this resource.
039    ///
040    /// @return the type
041    ///
042    ResourceType<?> type();
043
044    /// Returns a localized string representation of the instant
045    /// at which this resource was created or last modified.
046    ///
047    /// @return the string
048    ///
049    default String asOfLocalized() {
050        var asOf = asOf();
051        if (asOf == Instant.MIN) {
052            return "ages ago";
053        }
054        return DateTimeFormatter.ISO_LOCAL_DATE_TIME
055            .format(asOf.atZone(ZoneId.systemDefault()));
056    }
057}