ApplicationInfo: javadoc

This commit is contained in:
Yann Cébron
2019-01-31 19:36:38 +01:00
parent 66554b5877
commit 10a93f15ee
@@ -1,5 +1,5 @@
/*
* Copyright 2000-2015 JetBrains s.r.o.
* Copyright 2000-2019 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -24,19 +24,31 @@ import org.jetbrains.annotations.Nullable;
import java.awt.*;
import java.util.Calendar;
/**
* Provides IDE version/help and vendor information.
*/
public abstract class ApplicationInfo {
public abstract Calendar getBuildDate();
public abstract BuildNumber getBuild();
public abstract String getApiVersion();
public abstract String getMajorVersion();
public abstract String getMinorVersion();
public abstract String getMicroVersion();
public abstract String getPatchVersion();
public abstract String getVersionName();
/**
* Returns the first number from 'minor' part of the version. This method is temporary added because some products specify composite number (like '1.3')
* Returns the first number from 'minor' part of the version. This method is temporarily added because some products specify a composite number (like '1.3')
* in 'minor version' attribute instead of using 'micro version' (i.e. set minor='1' micro='3').
*
* @see org.jetbrains.intellij.build.ApplicationInfoProperties#minorVersionMainPart
*/
public final String getMinorVersionMainPart() {
@@ -48,28 +60,37 @@ public abstract class ApplicationInfo {
/**
* Use this method to refer to the company in official contexts where it may have any legal implications.
* @see #getShortCompanyName()
*
* @return full name of the product vendor, e.g. 'JetBrains s.r.o.' for JetBrains products
* @see #getShortCompanyName()
*/
public abstract String getCompanyName();
/**
* Use this method to refer to the company in a less formal way, e.g. in UI messages or directory names.
* @see #getCompanyName()
*
* @return shortened name of the product vendor without 'Inc.' or similar suffixes, e.g. 'JetBrains' for JetBrains products
* @see #getCompanyName()
*/
public abstract String getShortCompanyName();
public abstract String getCompanyURL();
public abstract String getJetbrainsTvUrl();
public abstract String getEvalLicenseUrl();
public abstract String getKeyConversionUrl();
@Nullable
public abstract Rectangle getAboutLogoRect();
public abstract boolean hasHelp();
public abstract boolean hasContextHelp();
public abstract String getFullVersion();
public abstract String getStrictVersion();
public static ApplicationInfo getInstance() {
@@ -84,7 +105,9 @@ public abstract class ApplicationInfo {
return ApplicationManager.getApplication() != null && getInstance() != null && getInstance().hasContextHelp();
}
/** @deprecated use {@link #getBuild()} instead (to remove in IDEA 16) */
/**
* @deprecated use {@link #getBuild()} instead (to remove in IDEA 16)
*/
@Deprecated
@SuppressWarnings("UnusedDeclaration")
public String getBuildNumber() {