Page History

Wiki MarkupNever use deprecated fields, methods, or classes in new code. The Java SE 6 documentation provides a [complete list|http://download.oracle.com/javase/6/docs/api/deprecated-list.html] of deprecated APIs \[[API 2006|AA. Bibliography#API 06]\]. Java provides a {{@deprecated}} annotation to indicate the deprecation of specific fields, methods, and classes. For instance, many methods of {{provides an @deprecated annotation to indicate the deprecation of specific fields, methods, and classes. For example, many methods of java.util.Date}}, such as {{Date.getYear()}}, have been explicitly deprecated. The rule [THI05-J. Do not use Thread.stop() to terminate threads|THI05-J. Do not use Thread.stop() to terminate threads] describes issues that can result from using the deprecated {{Thread.stop()}} method. method.

The Java SE documentation provides a list of deprecated APIs for each version of the language:

Programmers should use the list of deprecated functions specific to the language version they are using, although it may also be possible to avoid the use of APIs that are deprecated in later versions as well if suitable alternatives are available.

Obsolete fields, methods, and classes should not be used. Java lacks any annotation that indicates obsolescence; nevertheless, several classes and methods are documented as obsolete. For instance, the java.util.Dictionary<K,V> class is marked as obsolete; new code should use Wiki MarkupObsolete fields, methods, and classes should not be used. Java provides no annotation to indicate obsolescence, but several objects are documented as obsolete. For instance, the {{java.util.Dictionary}} class is marked as obsolete, and new code should use {{java.util.Map<K,V>}} instead \[ [API 2006|AA. Bibliography#API 06]\].

Finally, several classes and methods impose particular limitations on their use. For instance, all of the subclasses of the abstract class java.text.Format are thread-unsafe. These classes must be avoided in multithreaded code. For more information about thread-safety, see rule TSM04-J. Document thread-safety and use annotations where applicable.

2014].

Obsolete Methods and Classes

The following methods and classes listed in the following table must not be used:

Class or Method	Replacement	Rule
`java.lang.Character.isJavaLetter()`	`java.lang.Character.isJavaIdentifierStart()`


`java.lang.Character.isJavaLetterOrDigit()`	`java.lang.Character.isJavaIdentifierPart()`


`java.lang.Character.isSpace()`	`java.lang.Character.isWhitespace()`


`java.lang`

.reflect

.Class.newInstance()

java.lang.reflect.Constructor.newInstance()

ERR06-J. Do not

let code

throw undeclared checked exceptions
`java.util.Date` (many methods)	`java.util.Calendar`

java.util.

Dictionary

Dictionary<K,V>

java.util.Map<K,V>


`java.util.Properties.save()`	`java.util.Properties.store()`


`java.lang.Thread.run()`	`java.lang.Thread.start()`	THI00-J. Do not invoke Thread.run()
`java.lang.Thread.stop()`	`java.lang.Thread.interrupt()`	THI05-J. Do not use Thread.stop() to terminate threads
`java.lang.ThreadGroup` (many methods)

inherently unsafe

`java.util.concurrent.Executor`	THI01-J. Do not invoke ThreadGroup methods
java.util.Date	java.time (since Java 8)

The Java Virtual Machine The JVM Profiler Interface (JVMPI) and JVM Debug Interface (JVMDI) are also deprecated and have been replaced by the JVM Tool Interface (JVMTI) , (see rule ENV05-J. Do not deploy an application that can be remotely monitored for more information).

Risk Assessment

Using deprecated or obsolete classes or methods in program code can lead to erroneous behavior.

Rule	Severity	Likelihood	Remediation Cost	Priority	Level
MET02-J

high

Low

likely

Unlikely

medium

Medium

P18

P2

L1

L3

Automated Detection

Detecting uses of deprecated methods is straightforward. Obsolete methods and thread-unsafe methods have no automatic means of detection.

Tool

Version

Checker

Description

Parasoft Jtest

Include Page

	Parasoft_V
	Parasoft_V

CERT.MET02.DPRAPI
CERT.MET02.

...

THRD

Do not use deprecated APIs
Avoid calling unsafe deprecated methods of 'Thread' and 'Runtime'

SonarQube

Include Page

	SonarQube_V
	SonarQube_V

S1874

"@Deprecated" code should not be used

Related Guidelines

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6788c711-edc1-4ebb-944e-ba118e8e062b"><ac:plain-text-body><![CDATA[

[

ISO/IEC TR 24772:2010

http://www.aitcnet.org/isai/]

"

Deprecated Language Features [MEM

]" ]

]

></ac:plain-text-body></ac:structured-macro>


MITRE CWE	CWE-589,

"

Call to Non-ubiquitous API

"

Bibliography

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ad853b21-47fa-4ffc-af8b-406d8dee429a"><ac:plain-text-body><![CDATA[	[[API 2006	AA. Bibliography#API 06]]	[Deprecated API	http://java.sun.com/javase/6/docs/api/deprecated-list.html], [Dictionary	http://download.oracle.com/javase/6/docs/api/java/util/Dictionary.html]	]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ccd244cf-f2fe-4bb9-ac10-27457d72e6b2"><ac:plain-text-body><![CDATA[	[[SDN 2008	AA. Bibliography#SDN 08]]	Bug database, [Bug ID 4264153	http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4264153]	]]></ac:plain-text-body></ac:structured-macro>

Android Implementation Details

The Android SDK has deprecated and obsolete APIs. Also, there may exist incompatible APIs depending on the SDK version. Consequently, it is recommended that developers refer to the "Android API Differences Report" and consider replacing deprecated APIs.

Bibliography

[API 2014]	Deprecated API Interface `Map<K,V>`
[SDN 2008]	Bug database, Bug ID 4264153

...

Image Added Image Added MET01-J. Never use assertions to validate method parameters 05. Methods (MET)

Space shortcuts

Page tree

Versions Compared

Old Version 76

New Version Current

Key

Obsolete Methods and Classes

Risk Assessment

Automated Detection

Related Guidelines

Related Guidelines

Bibliography

Android Implementation Details

Bibliography