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;
024import java.util.Optional;
025
026/// Represents a resource handled by the builder. Resources can have names
027/// that may be referenced in [ResourceRequest]s.
028///
029public interface Resource {
030
031    /// The instant at which this resource was created or last modified.
032    ///
033    /// @return the instant
034    ///
035    default Instant asOf() {
036        return Instant.MIN;
037    }
038
039    /// Returns the type of this resource.
040    ///
041    /// @return the type
042    ///
043    ResourceType<?> type();
044
045    /// Returns the name of this resource if set.
046    ///
047    /// @return the optional
048    ///
049    Optional<String> name();
050
051    /// Returns a localized string representation of the instant
052    /// at which this resource was created or last modified.
053    ///
054    /// @return the string
055    ///
056    default String asOfLocalized() {
057        var asOf = asOf();
058        if (asOf == Instant.MIN) {
059            return "ages ago";
060        }
061        return DateTimeFormatter.ISO_LOCAL_DATE_TIME
062            .format(asOf.atZone(ZoneId.systemDefault()));
063    }
064}