FieldPosition getBeginIndex() method in Java with Example

The getBeginIndex() method of java.text.FieldPosition class is used to get the index of the beginning character of the FieldPosition object.

Syntax:

public int getBeginIndex()

Parameter: This method does not accept any argument as a parameter.

Return Value: This method returns the index of the beginning character of the FieldPosition object.

Below are the examples to illustrate the getBeginIndex() method:

Example 1:

Java

// Java program to demonstrate
// getBeginIndex() method

import java.text.*;
import java.util.*;
import java.io.*;

public class GFG {
    public static void main(String[] argv)
    {
        try {

            // Creating and initializing
            /// new FieldPosition Object
            FieldPosition pos
                = new FieldPosition(
                    DateFormat.Field.AM_PM);

            // getting begin index of FieldPosition Object
            // using getBeginIndex() method
            int i = pos.getBeginIndex();

            // display result
            System.out.println("begin index :- " + i);
        }

        catch (ClassCastException e) {

            System.out.println("Exception thrown : " + e);
        }
    }
}

Output:

begin index :- 0

Example 2:

Java

// Java program to demonstrate
// getBeginIndex() method

import java.text.*;
import java.util.*;
import java.io.*;

public class GFG {
    public static void main(String[] argv)
    {
        try {

            // Creating and initializing
            // new FieldPosition Object
            FieldPosition pos
                = new FieldPosition(
                    DateFormat.Field.AM_PM);

            // setting begin index
            pos.setBeginIndex(5);

            // getting begin index of FieldPosition Object
            // using getBeginIndex() method
            int i = pos.getBeginIndex();

            // display result
            System.out.println("begin index :- " + i);
        }

        catch (ClassCastException e) {

            System.out.println("Exception thrown : " + e);
        }
    }
}

Output:

begin index :- 5

Reference: https://docs.oracle.com/javase/9/docs/api/java/text/FieldPosition.html#setBeginIndex-int-