Deprecated API

Contents

• Interfaces
• Classes
• Exceptions
• Fields
• Methods
• Constructors

Interfaces

Interface	Description
org.apache.maven.shared.utils.io.DirectoryWalkListener	use java.nio.file.FileVisitor and related classes
org.apache.maven.shared.utils.io.ScanConductor	use java.nio.file.Files.walkFileTree() and related classes
org.apache.maven.shared.utils.logging.LoggerLevelRenderer	use org.apache.maven.message.MessageBuilderFactory (Maven 3.10.0 and later) or org.apache.maven.api.services.MessageBuilderFactory (Maven 4) instead
org.apache.maven.shared.utils.logging.MessageBuilder	use org.apache.maven.message.MessageBuilderFactory (Maven 3.10.0 and later) or org.apache.maven.api.services.MessageBuilderFactory (Maven 4) instead
org.apache.maven.shared.utils.xml.XMLWriter

Classes

Class	Description
org.apache.maven.shared.utils.cli.shell.CommandShell	Windows ME is long dead. Update to Windows 10 and use CmdShell.
org.apache.maven.shared.utils.io.DirectoryScanner	use java.nio.file.DirectoryStream or java.nio.file.Files.walkFileTree() and related classes
org.apache.maven.shared.utils.io.DirectoryScanResult	use java.nio.file.DirectoryStream and related classes
org.apache.maven.shared.utils.io.FileUtils.FilterWrapper	use org.apache.maven.shared.filtering.FilterWrapper
org.apache.maven.shared.utils.io.Java7Support	no longer needed, prefer to use Files methods directly.
org.apache.maven.shared.utils.io.MatchPattern	use java.nio.file.DirectoryStream.Filter<T> and related classes
org.apache.maven.shared.utils.io.MatchPatterns	use java.nio.file.DirectoryStream.Filter<T> and related classes
org.apache.maven.shared.utils.io.SelectorUtils	use java.nio.file.Files.walkFileTree() and related classes
org.apache.maven.shared.utils.io.WalkCollector	use java.nio.file.FileVisitor and related classes
org.apache.maven.shared.utils.logging.MessageUtils	use org.apache.maven.message.MessageBuilderFactory (Maven 3.10.0 and later) or org.apache.maven.api.services.MessageBuilderFactory (Maven 4) instead
org.apache.maven.shared.utils.Os	use org.apache.commons.lang3.SystemUtils instead
org.apache.maven.shared.utils.PathTool
org.apache.maven.shared.utils.ReaderFactory	use JDK methods instead
org.apache.maven.shared.utils.WriterFactory
org.apache.maven.shared.utils.xml.PrettyPrintXMLWriter	this class swallows and ignores IOExceptions. It is dangerous to use when writing to anything other than a StringWriter.
org.apache.maven.shared.utils.xml.XmlStreamReader	use org.apache.commons.io.input.XmlStreamReader instead
org.apache.maven.shared.utils.xml.XmlStreamWriter	use org.apache.commons.io.output.XmlStreamWriter instead
org.apache.maven.shared.utils.xml.XmlWriterUtil
org.apache.maven.shared.utils.xml.Xpp3Dom	use org.w3c.dom, JDOM, XOM, or SAX
org.apache.maven.shared.utils.xml.Xpp3DomBuilder	use org.w3c.dom, JDOM, XOM, or SAX
org.apache.maven.shared.utils.xml.Xpp3DomUtils	use org.w3c.dom, JDOM, XOM, or SAX
org.apache.maven.shared.utils.xml.Xpp3DomWriter	use org.w3c.dom, JDOM, XOM, or SAX

Exceptions

Exceptions	Description
org.apache.maven.shared.utils.xml.pull.XmlPullParserException	use org.w3c.dom, JDOM, XOM, or SAX

Fields

Field	Description
org.apache.maven.shared.utils.ReaderFactory.FILE_ENCODING	use java.nio.charset.Charset.defaultCharset()
org.apache.maven.shared.utils.ReaderFactory.ISO_8859_1	use java.nio.charset.StandardCharsets.ISO_8859_1
org.apache.maven.shared.utils.ReaderFactory.US_ASCII	use java.nio.charset.StandardCharsets.US_ASCII
org.apache.maven.shared.utils.ReaderFactory.UTF_16	use java.nio.charset.StandardCharsets.UTF_16
org.apache.maven.shared.utils.ReaderFactory.UTF_16BE	use java.nio.charset.StandardCharsets.UTF_16BE
org.apache.maven.shared.utils.ReaderFactory.UTF_16LE	use java.nio.charset.StandardCharsets.UTF_16LE
org.apache.maven.shared.utils.ReaderFactory.UTF_8	use java.nio.charset.StandardCharsets.UTF_8
org.apache.maven.shared.utils.WriterFactory.FILE_ENCODING	use java.nio.charset.Charset.defaultCharset()
org.apache.maven.shared.utils.WriterFactory.ISO_8859_1	use java.nio.charset.StandardCharsets.ISO_8859_1
org.apache.maven.shared.utils.WriterFactory.US_ASCII	use java.nio.charset.StandardCharsets.US_ASCII
org.apache.maven.shared.utils.WriterFactory.UTF_16	use java.nio.charset.StandardCharsets.UTF_16
org.apache.maven.shared.utils.WriterFactory.UTF_16BE	use java.nio.charset.StandardCharsets.UTF_16BE
org.apache.maven.shared.utils.WriterFactory.UTF_16LE	use java.nio.charset.StandardCharsets.UTF_16LE
org.apache.maven.shared.utils.WriterFactory.UTF_8	use java.nio.charset.StandardCharsets.UTF_8

Methods

Method	Description
org.apache.maven.shared.utils.cli.Commandline.addSystemEnvironment()	use Commandline.setShellEnvironmentInherited(boolean)
org.apache.maven.shared.utils.cli.CommandLineUtils.getSystemEnvVars()	use System#getenv()
org.apache.maven.shared.utils.cli.StreamPumper.close()	As of 3.2.0, removed without replacement.
org.apache.maven.shared.utils.cli.StreamPumper.flush()	As of 3.2.0, removed without replacement.
org.apache.maven.shared.utils.io.DirectoryScanner.getIncludedDirectories()	this method is buggy. Do not depend on it.
org.apache.maven.shared.utils.io.DirectoryScanner.getIncludedFiles()	this method does not work correctly on Windows.
org.apache.maven.shared.utils.io.FileUtils.cleanDirectory(File)	use org.apache.commons.io.FileUtils.cleanDirectory()
org.apache.maven.shared.utils.io.FileUtils.contentEquals(File, File)	use org.apache.commons.io.FileUtils.contentEquals()
org.apache.maven.shared.utils.io.FileUtils.copyDirectory(File, File)	use org.apache.commons.io.FileUtils.copyDirectory()
org.apache.maven.shared.utils.io.FileUtils.copyDirectoryStructure(File, File)	use org.apache.commons.io.FileUtils.copyDirectory()
org.apache.maven.shared.utils.io.FileUtils.copyFile(File, File)	use java.nio.file.Files.copy(source.toPath(), destination.toPath(), LinkOption.NOFOLLOW_LINKS, StandardCopyOption.REPLACE_EXISTING)
org.apache.maven.shared.utils.io.FileUtils.copyFileToDirectory(File, File)	use org.apache.commons.io.FileUtils.copyFileToDirectory()
org.apache.maven.shared.utils.io.FileUtils.copyURLToFile(URL, File)	use java.nio.file.Files.copy(source.openStream(), destination.toPath(), StandardCopyOption.REPLACE_EXISTING)
org.apache.maven.shared.utils.io.FileUtils.createTempFile(String, String, File)	use java.nio.file.Files.createTempFile()
org.apache.maven.shared.utils.io.FileUtils.delete(File)	use java.nio.file.Files.delete(file.toPath())
org.apache.maven.shared.utils.io.FileUtils.deleteDirectory(String)	use org.apache.commons.io.FileUtils.deleteDirectory()
org.apache.maven.shared.utils.io.FileUtils.deleteLegacyStyle(File)	use java.nio.file.Files.delete(file.toPath())
org.apache.maven.shared.utils.io.FileUtils.dirname(String)	use Paths.get(path).getParent().getName()
org.apache.maven.shared.utils.io.FileUtils.extension(String)	use org.apache.commons.io.FilenameUtils.getExtension
org.apache.maven.shared.utils.io.FileUtils.fileAppend(String, String)	use java.nio.file.Files.write(filename, data.getBytes(), StandardOpenOption.APPEND, StandardOpenOption.CREATE)
org.apache.maven.shared.utils.io.FileUtils.fileDelete(String)	use Files.delete(Paths.get(fileName))
org.apache.maven.shared.utils.io.FileUtils.fileExists(String)	use java.io.File.exists()
org.apache.maven.shared.utils.io.FileUtils.filename(String)	use Paths.get(path).getName()
org.apache.maven.shared.utils.io.FileUtils.fileRead(String)	use new String(java.nio.file.Files.readAllBytes(file))
org.apache.maven.shared.utils.io.FileUtils.fileReadArray(File)	use java.nio.file.Files.readAllLines()
org.apache.maven.shared.utils.io.FileUtils.fileWrite(String, String)	use java.nio.file.Files.write(filename, data.getBytes(), StandardOpenOption.CREATE)
org.apache.maven.shared.utils.io.FileUtils.fileWriteArray(File, String...)	use java.nio.file.Files.write(file.toPath(), data.getBytes(encoding), StandardOpenOption.CREATE)
org.apache.maven.shared.utils.io.FileUtils.forceDelete(String)	use org.apache.commons.io.FileUtils.deleteQuietly()
org.apache.maven.shared.utils.io.FileUtils.forceMkdir(File)	use org.apache.commons.io.FileUtils.forceMkdir()
org.apache.maven.shared.utils.io.FileUtils.getExtension(String)	use org.apache.commons.io.FilenameUtils.getExtension()
org.apache.maven.shared.utils.io.FileUtils.isSymbolicLink(File)	use java.nio.file.Files.isSymbolicLink(file.toPath())
org.apache.maven.shared.utils.io.FileUtils.isSymbolicLinkForSure(File)	use java.nio.file.Files.isSymbolicLink(file.toPath())
org.apache.maven.shared.utils.io.FileUtils.loadFile(File)	assumes the platform default character set
org.apache.maven.shared.utils.io.FileUtils.mkdir(String)	use java.nio.file.Files.createDirectories(Paths.get(dir))
org.apache.maven.shared.utils.io.FileUtils.normalize(String)	use org.apache.commons.io.FilenameUtils.normalize()
org.apache.maven.shared.utils.io.FileUtils.removeExtension(String)	use org.apache.commons.io.FilenameUtils.removeExtension()
org.apache.maven.shared.utils.io.FileUtils.rename(File, File)	use java.nio.file.Files.move()
org.apache.maven.shared.utils.io.FileUtils.sizeOfDirectory(String)	use org.apache.commons.io.FileUtils.sizeOf()
org.apache.maven.shared.utils.io.IOUtil.close(Channel)	use try-with-resources
org.apache.maven.shared.utils.io.IOUtil.contentEquals(InputStream, InputStream)	use org.apache.commons.io.IOUtils.contentEquals()
org.apache.maven.shared.utils.io.IOUtil.copy(InputStream, OutputStream)	use org.apache.commons.io.IOUtils.copy() or in Java 9 and later InputStream.transferTo().
org.apache.maven.shared.utils.io.IOUtil.toByteArray(InputStream)	use org.apache.commons.io.IOUtils.readFully().
org.apache.maven.shared.utils.io.IOUtil.toString(InputStream)	always specify a character encoding
org.apache.maven.shared.utils.logging.MessageBuilder.toString()	Rather use MessageBuilder.build()
org.apache.maven.shared.utils.PathTool.getRelativeFilePath(String, String)	use java.nio.file.Path.relativize() instead
org.apache.maven.shared.utils.PathTool.getRelativePath(String, String)	use java.nio.file.Path.relativize() instead
org.apache.maven.shared.utils.PropertyUtils.loadProperties(URL)	use PropertyUtils.loadOptionalProperties(java.net.URL) instead. This method should not be used as it suppresses exceptions silently when loading properties fails and returns null instead of an empty Properties instance when the given URL is null.
org.apache.maven.shared.utils.ReaderFactory.newPlatformReader(File)	always specify an encoding. Do not depend on the default platform character set.
org.apache.maven.shared.utils.ReaderFactory.newReader(InputStream, String)	use new InputStreamReader(in, encoding) instead
org.apache.maven.shared.utils.ReaderFactory.newXmlReader(InputStream)	use org.apache.commons.io.input.XmlStreamReader instead
org.apache.maven.shared.utils.StringUtils.clean(String)	use StringUtils.trim(String) instead.
org.apache.maven.shared.utils.StringUtils.concatenate(Object...)	use java.lang.String.join() or Arrays.stream(array).map(Object::toString).collect(Collectors.joining("")) instead
org.apache.maven.shared.utils.StringUtils.contains(String, char)	use String.indexOf(int) and test for >= 0 instead. Note that the JDK method throws NullPointerException when str is null, where this method returns false.
org.apache.maven.shared.utils.StringUtils.defaultString(Object)	use java.util.Objects.toString()
org.apache.maven.shared.utils.StringUtils.equals(String, String)	use java.util.Objects.equals()
org.apache.maven.shared.utils.StringUtils.join(Object[], String)	use java.lang.String.join() or Arrays.stream(array).map(Object::toString).collect(Collectors.joining(separator)) instead
org.apache.maven.shared.utils.StringUtils.replace(String, char, char)	use String.replace(char, char) instead. Note that the JDK method throws NullPointerException when text is null, where this method returns null.
org.apache.maven.shared.utils.StringUtils.split(String)	use java.lang.String.split() instead. Be careful when migrating. String.split() splits on a regular expression so while it can do anything this method does, it is not a drop-in replacement.
org.apache.maven.shared.utils.StringUtils.unifyLineSeparators(String)	this method produces platform dependent code and contributes to non-reproducible builds. In the context of Maven, this is almost never what's needed. Remove calls to this method and do not replace them. That is, change StringUtils.unifyLineSeparators(s) to simply s.
org.apache.maven.shared.utils.WriterFactory.newPlatformWriter(OutputStream)	always specify an encoding. Do not depend on the default platform character set.
org.apache.maven.shared.utils.WriterFactory.newWriter(OutputStream, String)	use new OutputStreamWriter(out, encoding) instead
org.apache.maven.shared.utils.WriterFactory.newXmlWriter(OutputStream)	use org.apache.commons.io.output.XmlStreamWriter instead
org.apache.maven.shared.utils.xml.Xpp3Dom.isEmpty(String)	use str == null || str.trim().isEmpty()
org.apache.maven.shared.utils.xml.Xpp3Dom.isNotEmpty(String)	use str != null && !str.isEmpty()
org.apache.maven.shared.utils.xml.Xpp3DomBuilder.build(InputStream, String, boolean)	use the two-arg variant
org.apache.maven.shared.utils.xml.Xpp3DomUtils.isEmpty(String)	use str == null || String.isBlank(str) (Java 11+) or org.apache.commons.lang3.StringUtils.isBlank(str)

Constructors

Constructor	Description
org.apache.maven.shared.utils.PathTool()	This is a utility class with only static methods. Don't create instances of it.
org.apache.maven.shared.utils.PropertyUtils()	This is a utility class with only static methods. Don't create instances of it.