Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Road toward turning on auto formatting #2790

Merged
merged 4 commits into from
Feb 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/main/java/org/apache/ibatis/annotations/Arg.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -30,6 +30,7 @@
* The annotation that specify a mapping definition for the constructor argument.
*
* @see ConstructorArgs
*
* @author Clinton Begin
*/
@Documented
Expand Down Expand Up @@ -91,6 +92,7 @@
* Returns the parameter name for applying this mapping.
*
* @return the parameter name
*
* @since 3.4.3
*/
String name() default "";
Expand All @@ -99,6 +101,7 @@
* Returns the column prefix that use when applying {@link #resultMap()}.
*
* @return the column prefix
*
* @since 3.5.0
*/
String columnPrefix() default "";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -23,7 +23,6 @@

/**
* The marker annotation that indicate a constructor for automatic mapping.
*
* <p>
* <b>How to use:</b>
*
Expand All @@ -47,6 +46,7 @@
* </pre>
*
* @author Tim Chen
*
* @since 3.4.3
*/
@Documented
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -27,7 +27,6 @@

/**
* The annotation that specify to use cache on namespace(e.g. mapper interface).
*
* <p>
* <b>How to use:</b>
*
Expand Down Expand Up @@ -96,6 +95,7 @@
* Returns property values for a implementation object.
*
* @return property values
*
* @since 3.4.2
*/
Property[] properties() default {};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -23,9 +23,8 @@

/**
* The annotation that reference a cache.
*
* <p>If you use this annotation, should be specified either {@link #value()} or {@link #name()} attribute.
*
* <p>
* If you use this annotation, should be specified either {@link #value()} or {@link #name()} attribute.
* <p>
* <b>How to use:</b>
*
Expand Down Expand Up @@ -55,6 +54,7 @@
* Returns the namespace name to reference a cache.
*
* @return the namespace name
*
* @since 3.4.2
*/
String name() default "";
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/apache/ibatis/annotations/Case.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -28,6 +28,7 @@
* @see Arg
* @see Results
* @see ConstructorArgs
*
* @author Clinton Begin
*/
@Documented
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -23,7 +23,6 @@

/**
* The annotation that be grouping mapping definitions for constructor.
*
* <p>
* <b>How to use:</b>
*
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/org/apache/ibatis/annotations/Delete.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -24,7 +24,6 @@

/**
* The annotation that specify an SQL for deleting record(s).
*
* <p>
* <b>How to use:</b>
*
Expand All @@ -51,13 +50,16 @@

/**
* @return A database id that correspond this statement
*
* @since 3.5.5
*/
String databaseId() default "";

/**
* The container annotation for {@link Delete}.
*
* @author Kazuki Shimizu
*
* @since 3.5.5
*/
@Documented
Expand Down
10 changes: 7 additions & 3 deletions src/main/java/org/apache/ibatis/annotations/DeleteProvider.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -24,7 +24,6 @@

/**
* The annotation that specify a method that provide an SQL for deleting record(s).
*
* <p>
* <b>How to use:</b>
*
Expand Down Expand Up @@ -55,7 +54,9 @@
* Specify a type that implements an SQL provider method.
*
* @return a type that implements an SQL provider method
*
* @since 3.5.2
*
* @see #type()
*/
Class<?> value() default void.class;
Expand All @@ -67,13 +68,13 @@
* </p>
*
* @return a type that implements an SQL provider method
*
* @see #value()
*/
Class<?> type() default void.class;

/**
* Specify a method for providing an SQL.
*
* <p>
* Since 3.5.1, this attribute can omit.
* If this attribute omit, the MyBatis will call a method that decide by following rules.
Expand All @@ -95,13 +96,16 @@

/**
* @return A database id that correspond this provider
*
* @since 3.5.5
*/
String databaseId() default "";

/**
* The container annotation for {@link DeleteProvider}.
*
* @author Kazuki Shimizu
*
* @since 3.5.5
*/
@Documented
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/ibatis/annotations/Flush.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -23,7 +23,6 @@

/**
* The maker annotation that invoke a flush statements via Mapper interface.
*
* <p>
* <b>How to use:</b>
*
Expand All @@ -35,6 +34,7 @@
* </pre>
*
* @since 3.3.0
*
* @author Kazuki Shimizu
*/
@Documented
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/org/apache/ibatis/annotations/Insert.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -24,7 +24,6 @@

/**
* The annotation that specify an SQL for inserting record(s).
*
* <p>
* <b>How to use:</b>
*
Expand All @@ -51,13 +50,16 @@

/**
* @return A database id that correspond this statement
*
* @since 3.5.5
*/
String databaseId() default "";

/**
* The container annotation for {@link Insert}.
*
* @author Kazuki Shimizu
*
* @since 3.5.5
*/
@Documented
Expand Down
10 changes: 7 additions & 3 deletions src/main/java/org/apache/ibatis/annotations/InsertProvider.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -24,7 +24,6 @@

/**
* The annotation that specify a method that provide an SQL for inserting record(s).
*
* <p>
* <b>How to use:</b>
*
Expand Down Expand Up @@ -55,7 +54,9 @@
* Specify a type that implements an SQL provider method.
*
* @return a type that implements an SQL provider method
*
* @since 3.5.2
*
* @see #type()
*/
Class<?> value() default void.class;
Expand All @@ -67,13 +68,13 @@
* </p>
*
* @return a type that implements an SQL provider method
*
* @see #value()
*/
Class<?> type() default void.class;

/**
* Specify a method for providing an SQL.
*
* <p>
* Since 3.5.1, this attribute can omit.
* If this attribute omit, the MyBatis will call a method that decide by following rules.
Expand All @@ -95,13 +96,16 @@

/**
* @return A database id that correspond this provider
*
* @since 3.5.5
*/
String databaseId() default "";

/**
* The container annotation for {@link InsertProvider}.
*
* @author Kazuki Shimizu
*
* @since 3.5.5
*/
@Documented
Expand Down
3 changes: 1 addition & 2 deletions src/main/java/org/apache/ibatis/annotations/Lang.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -25,7 +25,6 @@

/**
* The annotation that specify a {@link LanguageDriver} to use.
*
* <p>
* <b>How to use:</b>
*
Expand Down
5 changes: 4 additions & 1 deletion src/main/java/org/apache/ibatis/annotations/Many.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -27,6 +27,7 @@
*
* @see Result
* @see Results
*
* @author Clinton Begin
*/
@Documented
Expand All @@ -37,6 +38,7 @@
* Returns the columnPrefix.
*
* @return the columnPrefix.
*
* @since 3.5.5
*/
String columnPrefix() default "";
Expand All @@ -45,6 +47,7 @@
* Returns the result map id used to map collection.
*
* @return the result map id
*
* @since 3.5.5
*/
String resultMap() default "";
Expand Down
3 changes: 1 addition & 2 deletions src/main/java/org/apache/ibatis/annotations/MapKey.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2009-2022 the original author or authors.
* Copyright 2009-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -23,7 +23,6 @@

/**
* The annotation that specify the property name(or column name) for a key value of {@link java.util.Map}.
*
* <p>
* <b>How to use:</b>
*
Expand Down
Loading