xref: /aosp_15_r20/external/aws-sdk-java-v2/build-tools/src/main/resources/messages.xml (revision 8a52c7834d808308836a99fc2a6e0ed8db339086)
1<!--
2  ~ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  ~
4  ~ Licensed under the Apache License, Version 2.0 (the "License").
5  ~ You may not use this file except in compliance with the License.
6  ~ A copy of the License is located at
7  ~
8  ~  http://aws.amazon.com/apache2.0
9  ~
10  ~ or in the "license" file accompanying this file. This file is distributed
11  ~ on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  ~ express or implied. See the License for the specific language governing
13  ~ permissions and limitations under the License.
14  -->
15
16<MessageCollection>
17    <Detector class="software.amazon.awssdk.buildtools.findbugs.DisallowMethodCall" >
18        <Details>This detector checks for method calls that are not allowed for use.</Details>
19    </Detector>
20    <Detector class="software.amazon.awssdk.buildtools.findbugs.ToBuilderIsCorrect" >
21        <Details>This detector checks for correct CopyableBuilder definition.</Details>
22    </Detector>
23
24    <BugPattern type="SDK_BAD_METHOD_CALL">
25        <ShortDescription>Bad method call</ShortDescription>
26
27        <LongDescription>
28            <![CDATA[
29                {1} uses a method that is prohibited.
30                The headers() and rawQueryParameters() methods create a deep copy of the data, which can result in
31                significant memory pressure. Instead of retrieving a copy of the headers to look at it, use methods like
32                hasHeaders(), firstMatchingHeader(...) or forEachHeader(..) which may be optimized in the type to avoid
33                copying the data.
34            ]]>
35        </LongDescription>
36
37        <Details>
38            <![CDATA[
39                The headers() and rawQueryParameters() methods create a deep copy of the data, which can result in
40                significant memory pressure. Instead of retrieving a copy of the headers to look at it, use methods like
41                hasHeaders(), firstMatchingHeader(...) or forEachHeader(..) which may be optimized in the type to avoid
42                copying the data.
43            ]]>
44        </Details>
45    </BugPattern>
46    <BugCode abbrev="BM">Bad method call</BugCode>
47
48    <BugPattern type="BAD_TO_BUILDER">
49        <ShortDescription>Bad toBuilder implementation</ShortDescription>
50        <LongDescription>Bad toBuilder implementation. See the SpotBugs logs for problem details.</LongDescription>
51        <Details>Bad toBuilder implementation. See the SpotBugs logs for problem details.</Details>
52    </BugPattern>
53    <BugCode abbrev="BTB">Bad toBuilder implementation</BugCode>
54</MessageCollection>
55