How to read a file on the classpath in Java

There are often programming situations when you need to read a file on the classpath via Java. In this article, I will show you how to write code for this.

Reading a file on the classpath

Let us first take a look at the code that you need to write to read a file on the classpath.

public class ReadFileFromClassPathDemo {  public static void main(String[] args) throws IOException {    // read in the file from the resources directory    ClassLoader classLoader = ReadFileFromClassPathDemo.class.getClassLoader();    URL url = classLoader.getResource("input.txt");    String fileName = url.getFile();    File file = new File(fileName);    String str = new String(Files.readAllBytes(file.toPath()));    System.out.println(str);  }}

Java has an in-built class called ClassLoader.  It is used to dynamically load classes. It can also be used to load resources from the classpath. The code above first obtains a ClassLoader. It then invokes the getResource method on the classLoader. This loads the resource (in this case a file named input.txt) from the file system and returns an URL instance. The URL class has a getFile method that returns the fully qualified filename.  A File object is then created using the filename. Finally, the Files.readAllBytes method is used to then read the contents of the file into a String.

Running code in Eclipse

In case you need to test the code above from an IDE like Eclipse, you need to do the following:

Step 1 – Right-click on the class name and click Run As > Run Configurations:

Step 2 – Click on the Dependencies Tab:

Step 3 – Click on Classpath entries. Click on Advanced > Add External Folder:

Step 4 – Navigate to the file system and select the folder which contains the file to be read (D:/Data/Temp in my case):

Step 5 – Verify that the folder is added to the classpath. Click on Apply and Run:

Step 6 – Verify that the file is read and its contents are displayed on the console:

Maven project

In the case of a Maven project, anything placed within the src/main/resources folder of the Maven project is automatically available on the classpath. So, if you place your input file in the src/main/resources folder, the code above will be able to read it.

Further Reading

Conclusion

So, in this article, we saw how to read a file on the classpath via Java. We also saw how to run the code in Eclipse.

Comments

Post a Comment

Popular posts from this blog

How to use logging in SpringBoot with code samples

Image
In this article, we will learn how to use logging in SpringBoot. Introduction There are several Java logging frameworks like logback, log4j, and so on. Spring Boot supports out-of-the-box support for logback. Let us learn how to use logging in SpringBoot with logback. Step 1 – Create a New Maven Project Create a new Maven project. (Refer to  this  blog post). This will create a project in Eclipse as follows:   Step 2 – Add the Spring Boot Dependencies Add the spring-boot-starter-web dependency to the pom.xml . So, the pom.xml should look as follows: <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.learnjava</groupId> <artifactId>learnjava-springboot-logging-example</artifactId> <version>0.0.1-SNAPSHOT&
Read more

Python While Loop with code samples

Much like a Java while loop, you can use a Python while loop to repeatedly execute a block of code as long as a condition is true. In this article, we will learn more about the Python while loop. Python While loop Syntax A while loop in Python has the following syntax: while <condition>: loop body The while keyword is followed by a condition. If the condition evaluates to true, the body of the loop is executed. Once the body of the loop is completed, the condition is checked again and this is repeated until the condition evaluates to false at which point the loop is exited. While loop Sample Code The following code demonstrates how you can use the while loop: num=10counter=1total=0while counter<=num: total += counter counter+=1print("sum of first 10 numbers is",total) This code adds the numbers from 1 to 10 and prints the sum. It uses a while loop to iterate from 1 to 10. The while loop checks the condition counter <= num and if so adds the current value of count
Read more

How to convert a List to a Set

In this blog post ,I will be showing you how you can convert a List to a Set. Consider the following code snippet: public class ListToSetDemo {public static void main(String[] args) {List<Integer> list = Arrays.asList(5,3,11,15,9);//Method 1Set<Integer> set = new HashSet<Integer>(list);System.out.println("Set is "+set);//method 2Set<Integer> set2 = new HashSet<Integer>();set2.addAll(list);System.out.println("Set is "+set2);}} This code demonstrates two ways to convert a List to a Set. Method 1 Here, we are creating a new HashSet . We are invoking the constructor that accepts a Collection object. Here, we are passing in the input list to this constructor.   Method 2 Here again, we are creating a new HashSet . However, we are using the default constructor. We are then invoking the addAll method and passing in the input list.   When you run this code, it will print the following output: Set is [3, 5, 9, 11, 15]Set is [3, 5, 9, 11, 15] No
Read more