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

Java 8 DoubleFunction Example

In this blog post, I will be explaining how the Java 8 functional interface DoubleFunction works. To know more about functional interfaces, you can refer  this  blog post. Edit The   DoubleFunction interface provides a method called apply . It accepts a single parameter of double data type. It returns a result of any data type. So it basically applies the logic in the apply method to the input parameter and returns the result. The DoubleFunction interface is a specialization of the Function interface. While the Function interface accepts any data type, the DoubleFunction interface accepts a long value. To see an example of the Function interface, refer to  this  blog post. DoubleFunction Interface that returns an Integer Consider the following code snippet: DoubleFunction<Integer> integerRetriever = input -> new Double(input).intValue();Double input = 4.8;System.out.println("Integer Value "+integerRetriever.apply(input) );   Here, we have written a   Doubl...
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, 1...
Read more

ArrayList Vs LinkedList

In this blog post, I will be comparing the ArrayList and LinkedList classes. I will be explaining how they are similar, how they are different and when you should use which.   Similarities: Both are Collections and implement the List interface Both are used to store a dynamic number of elements (Primitive or Object type) Differences ArrayList uses an array data structure internally to store the data. A LinkedList on the other hand, uses a doubly linked list internally as the data structure to store data. If you are not familiar with what a Linked List data structure is, you can refer this link . When you need to insert or delete data from the bottom of the List, an ArrayList is faster. If you need to insert or delete an element from the middle of the list,  a LinkedList is faster. An ArrayList  uses an array to store the data internally. So when you insert or delete an element from the bottom of the list, this does not affect the array. However if you insert or delete an element...
Read more