Skip to content

Commit

Permalink
Add ForbidJavax Annotation (#2442)
Browse files Browse the repository at this point in the history
Add ForbidJavax Annotation

To address: palantir/gradle-baseline#2366
  • Loading branch information
mglazer authored Aug 24, 2022
1 parent 82b00ca commit 918fc0f
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
5 changes: 5 additions & 0 deletions changelog/@unreleased/pr-2442.v2.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
type: improvement
improvement:
description: Add `@ForbidJavax` Annotation
links:
- https://github.com/palantir/conjure-java-runtime/pull/2442
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/*
* (c) Copyright 2022 Palantir Technologies Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.palantir.errorprone;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* Annotation applied to any method parameter which requires that all input types
* include at least one Jakarta EE 9 type, such as <code>jakarta.ws.rs.Path</code>
* or <code>jakarta.ws.rs.core.Feature</code> instead of the legacy <code>javax</code>
* versions of those.
*
* This sprinkling is required since many methods take a simple <code>Object</code> type
* and let Jersey determine what to do with the object at runtime. In order to obtain better
* compile time checking, this method can be applied.
*
* This is primarily depended on by the gradle-baseline errorprone tooling.
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.PARAMETER)
public @interface ForbidJavax {}

0 comments on commit 918fc0f

Please sign in to comment.