rspec/rules/S3039/java/rule.adoc
2022-02-04 16:28:24 +00:00

46 lines
1.5 KiB
Plaintext

Just as you can't cut something into three halves, you can't grab a ``++substring++`` that starts or ends outside the original ``++String++``'s bounds, you can't use ``++substring++`` to get a reversed portion of a ``++String++``, and you can't get the ``++charAt++`` a value that's before the ``++String++`` starts or after it ends.
This rule detects when negative literal or ``++String::length++`` is passed as an argument to the ``++String::substring++``, ``++String::charAt++`` and related methods.
== Noncompliant Code Example
[source,java]
----
String speech = "Now is the time for all good people to come to the aid of their country.";
String substr1 = speech.substring(-1, speech.length()); // Noncompliant; start and end values both bad
String substr2 = speech.substring(speech.length(), 0); // Noncompliant, start value must be < end value
char ch = speech.charAt(speech.length()); // Noncompliant
----
== Compliant Solution
[source,java]
----
String speech = "Now is the time for all good people to come to the aid of their country.";
String substr1 = speech; // Closest correct values to original code yield whole string
String substr2 = new StringBuilder(speech).reverse().toString()
char ch = speech.charAt(speech.length()-1);
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::comments-and-links.adoc[]
endif::env-github,rspecator-view[]