oshi.software.os.ApplicationInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oshi-core Show documentation
The newest version!
/*
 * Copyright 2025 The OSHI Project Contributors
 * SPDX-License-Identifier: MIT
 */
package oshi.software.os;

import java.util.HashMap;
import java.util.Map;

/**
 * Represents common information about an installed application across different operating systems. This class provides
 * standardized access to essential application details while allowing flexibility for OS-specific fields via an
 * additional information map.
 */
public class ApplicationInfo {

    /** The name of the application. */
    private final String name;
    /** The version of the application. */
    private final String version;
    /** The vendor or publisher of the application. */
    private final String vendor;
    /**
     * The installation or last modified timestamp of the application in milliseconds since epoch. This represents the
     * Unix timestamp.
     */
    private final long timestamp;
    /**
     * A map containing additional application details such as install location, source, etc. Keys are field names, and
     * values are corresponding details.
     */
    private final Map additionalInfo;

    /**
     * Constructs an {@code ApplicationInfo} object with the specified details.
     *
     * @param name           The name of the application.
     * @param version        The version of the application.
     * @param vendor         The vendor or publisher of the application.
     * @param timestamp      The installation or last modified timestamp in milliseconds since epoch.
     * @param additionalInfo A map of additional information (can be {@code null}, in which case an empty map is used).
     */
    public ApplicationInfo(String name, String version, String vendor, long timestamp,
            Map additionalInfo) {
        this.name = name;
        this.version = version;
        this.vendor = vendor;
        this.timestamp = timestamp;
        this.additionalInfo = additionalInfo != null ? new HashMap<>(additionalInfo) : new HashMap<>();
    }

    /**
     * Gets the name of the installed application.
     *
     * @return The application name, or an empty string if not available.
     */
    public String getName() {
        return name;
    }

    /**
     * Gets the version of the installed application.
     *
     * @return The application version, or an empty string if not available.
     */
    public String getVersion() {
        return version;
    }

    /**
     * Gets the vendor or publisher of the installed application.
     *
     * @return The vendor name, or an empty string if not available.
     */
    public String getVendor() {
        return vendor;
    }

    /**
     * Gets the last modified or installation time of the application. The timestamp is represented in milliseconds
     * since the Unix epoch (January 1, 1970, UTC).
     * 
     * - On Windows, this corresponds to the application's install date. - On Linux, it represents the package's
     * installation or last modified time. - On macOS, it reflects the last modification timestamp of the application
     * bundle.
     * 
     *
     * @return The last modified time in epoch milliseconds, or {@code 0} if unavailable.
     */
    public long getTimestamp() {
        return timestamp;
    }

    /**
     * Gets additional application details that are OS-specific and not covered by the main fields. This map may include
     * attributes like installation location, source, architecture, or other metadata.
     *
     * @return A map containing optional key-value pairs of application details.
     */
    public Map getAdditionalInfo() {
        return additionalInfo;
    }

    @Override
    public String toString() {
        return "AppInfo{" + "name=" + name + ", version=" + version + ", vendor=" + vendor + ", timestamp=" + timestamp
                + ", additionalInfo=" + additionalInfo + '}';
    }
}