Which String method: "contains" or "indexOf > -1"?
Take a look at the java.lang.String
source code. The contains
method is implemented using a call to indexOf
, so they are essentially the same.
public boolean contains(CharSequence s) {
return indexOf(s.toString()) > -1;
}
You should use whichever method makes your code more readable. If you are checking to see if a String contains a specific substring, use contains
. If you are looking for the substring's starting index, use indexOf
.
Edit:
A couple of answers mention that indexOf
should be preferred over contains
due to the fact that contains
makes an additional method call, and is thus, less efficient. This is wrong. The overhead caused by an additional method call in this case is totally insignificant. Use whichever method makes the most sense in the context of your implementation. This will make your code more readable.
If the goal is to determine if one String contains another, then contains()
is the clear winner. It will make other developers more efficient in understanding your intent.
I thought I'd take an empirical approach to this question, instead of guessing about how the overhead of the additional method call would affect the outcome. I took the indexOf
benchmark from this answer, and added two benchmark methods for contains()
(one that takes a string constant and another that takes a variable). I'm using the just-released 1.8.0_71 running on Windows x64.
# JMH 1.11.3 (released 8 days ago)
# VM version: JDK 1.8.0_71, VM 25.71-b15
Benchmark Mode Cnt Score Error Units
IndexOfTest.containsString avgt 30 26.596 ± 0.099 ns/op
IndexOfTest.containsStringIndirect avgt 30 28.683 ± 0.088 ns/op
IndexOfTest.indexOfChar avgt 30 26.855 ± 0.171 ns/op
IndexOfTest.indexOfCharIndirect avgt 30 25.833 ± 0.116 ns/op
IndexOfTest.indexOfString avgt 30 26.192 ± 0.107 ns/op
IndexOfTest.indexOfStringIndirect avgt 30 27.547 ± 0.152 ns/op
Note that the benchmark measurements are nanoseconds per operation. So comparing contains("z") vs. indexOf("z"), the indexOf() is very slightly faster, but by less than 0.6ns. Interestingly enough, the indirect (using the variable) has a larger difference of a little over 1ns.
I've placed the code for this benchmark on GitHub: https://github.com/tedyoung/indexof-contains-benchmark