test/cuba
1
0
Fork 0
mirror of https://gitee.com/jmix/cuba.git synced 2024-12-04 04:07:42 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Using INTERNAL mark in JavaDocs of public methods for internal use.

Browse Source
This commit is contained in:
Konstantin Krivopustov 2015-09-18 08:57:26 +00:00
parent d6c87624de
commit 4d87f98b15
13 changed files with 47 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
modules/core/src/com/haulmont/cuba/core/sys/persistence/DbmsType.java
View File

@ -9,7 +9,8 @@ import com.haulmont.cuba.core.sys.AppContext;
import org.apache.commons.lang.StringUtils;
/**
* System level wrapper around DBMS-related application properties. For internal use only.
* INTERNAL.
* System level wrapper around DBMS-related application properties.
*
* <p>For data conversion on the middleware use {@link DbTypeConverter} obtained from
* {@link com.haulmont.cuba.core.Persistence} bean.

2
modules/global/src/com/haulmont/chile/core/datatypes/Datatypes.java
View File

@ -118,7 +118,7 @@ public final class Datatypes {
return format;
}
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
public static void setFormatStrings(Locale locale, FormatStrings formatStrings) {
instance.putFormat(locale, formatStrings);
}

16
modules/global/src/com/haulmont/cuba/core/entity/BaseGenericIdEntity.java
View File

@ -71,42 +71,42 @@ public abstract class BaseGenericIdEntity<T> extends AbstractInstance implements
out.defaultWriteObject();
}
/** For internal use. */
/** INTERNAL. */
public boolean __new() {
return __new;
}
/** For internal use. */
/** INTERNAL. */
public void __new(boolean cubaNew) {
this.__new = cubaNew;
}
/** For internal use. */
/** INTERNAL. */
public boolean __managed() {
return __managed;
}
/** For internal use. */
/** INTERNAL. */
public void __managed(boolean cubaManaged) {
this.__managed = cubaManaged;
}
/** For internal use. */
/** INTERNAL. */
public boolean __detached() {
return __detached;
}
/** For internal use. */
/** INTERNAL. */
public void __detached(boolean detached) {
this.__detached = detached;
}
/** For internal use. */
/** INTERNAL. */
public boolean __removed() {
return __removed;
}
/** For internal use. */
/** INTERNAL. */
public void __removed(boolean removed) {
this.__removed = removed;
}

20
modules/global/src/com/haulmont/cuba/core/entity/SoftDelete.java
View File

@ -14,13 +14,29 @@ import java.util.Date;
*/
public interface SoftDelete {
/**
* Returns true if the entity is deleted.
*/
Boolean isDeleted();
/**
* Returns deletion timestamp or null if not deleted.
*/
Date getDeleteTs();
void setDeleteTs(Date deleteTs);
/**
* Returns login name of the user who deleted the entity
* or null if not deleted.
*/
String getDeletedBy();
/**
* INTERNAL. Sets soft deletion timestamp.
*/
void setDeleteTs(Date deleteTs);
/**
* INTERNAL. Sets login name of the user who deleted the entity.
*/
void setDeletedBy(String deletedBy);
}

3
modules/global/src/com/haulmont/cuba/core/global/ExtendedEntities.java
View File

@ -141,8 +141,7 @@ public class ExtendedEntities {
}
/**
* Import replaced meta class from metadata. </br>
* CAUTION: For internal use only!
* INTERNAL. Import replaced meta class from metadata.
*/
public void registerReplacedMetaClass(MetaClass metaClass) {
replacedMetaClasses.put(metaClass.getJavaClass(), metaClass);

4
modules/gui/src/com/haulmont/cuba/gui/components/AbstractFrame.java
View File

@ -41,7 +41,7 @@ public class AbstractFrame implements Frame, Component.Wrapper, Component.Ordere
public AbstractFrame() {
}
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
public void setWrappedFrame(Frame frame) {
this.frame = frame;
}
@ -333,7 +333,7 @@ public class AbstractFrame implements Frame, Component.Wrapper, Component.Ordere
return (T) _companion;
}
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
public void setCompanion(Object companion) {
this._companion = companion;
}

4
modules/gui/src/com/haulmont/cuba/gui/components/AbstractWindow.java
View File

@ -104,7 +104,7 @@ public class AbstractWindow extends AbstractFrame
((Window) frame).setDescription(description);
}
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
@Override
public Window getWrappedWindow() {
return (Window) frame;
@ -237,7 +237,7 @@ public class AbstractWindow extends AbstractFrame
return ((Window) frame).close(actionId, force);
}
/** For internal use only. Don't call or override in application code. */
/** INTERNAL. Don't call or override in application code. */
@Override
public void closeAndRun(String actionId, Runnable runnable) {
((Window) frame).closeAndRun(actionId, runnable);

5
modules/gui/src/com/haulmont/cuba/gui/components/Component.java
View File

@ -46,8 +46,9 @@ public interface Component {
* @return Parent of component.
*/
Component getParent();
/**
* This method for internal use only. <br/>
* INTERNAL.<br/>
*
* {@link Component.Container#add(Component)} is normally used for adding components
* to a parent and the used method will call this method implicitly.
@ -57,7 +58,7 @@ public interface Component {
void setParent(Component parent);
String getDebugId();
/** For internal use only. Managed by debug Id system. */
/** INTERNAL. Managed by debug Id system. */
void setDebugId(String id);
/** Is component in enabled state? */

8
modules/gui/src/com/haulmont/cuba/gui/components/Frame.java
View File

@ -39,7 +39,7 @@ public interface Frame
*/
FrameContext getContext();
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
void setContext(FrameContext ctx);
/**
@ -47,7 +47,7 @@ public interface Frame
*/
DsContext getDsContext();
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
void setDsContext(DsContext dsContext);
/**
@ -61,10 +61,10 @@ public interface Frame
*/
void setMessagesPack(String name);
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
void registerComponent(Component component);
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
@Nullable
Component getRegisteredComponent(String id);

6
modules/gui/src/com/haulmont/cuba/gui/components/Window.java
View File

@ -131,7 +131,7 @@ public interface Window extends Frame, Component.HasCaption {
*/
boolean close(String actionId, boolean force);
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
void closeAndRun(String actionId, Runnable runnable);
/**
@ -171,7 +171,7 @@ public interface Window extends Frame, Component.HasCaption {
*/
WindowManager getWindowManager();
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
void setWindowManager(WindowManager windowManager);
@ -360,9 +360,9 @@ public interface Window extends Frame, Component.HasCaption {
}
/**
* INTERNAL.
* Interface implemented by screen controllers which are not themselves windows,
* but has {@link Window} interface and delegate work to wrapped real window.
* <p/> For internal use only.
*/
interface Wrapper {
Window getWrappedWindow();

2
modules/gui/src/com/haulmont/cuba/gui/export/ExportDisplay.java
View File

@ -55,6 +55,6 @@ public interface ExportDisplay {
*/
void show(FileDescriptor fileDescriptor);
/** For internal use only. Don't call from application code. */
/** INTERNAL. Don't call from application code. */
void setFrame(Frame frame);
}

2
modules/web-toolkit/src/com/haulmont/cuba/web/toolkit/ui/client/jqueryfileupload/CubaFileUploadProgressWindow.java
View File

@ -572,7 +572,7 @@ public class CubaFileUploadProgressWindow extends VOverlay implements KeyDownHan
return curtain;
}
/** For internal use only. May be removed or replaced in the future. */
/** INTERNAL. May be removed or replaced in the future. */
public void setResizable(boolean resizability) {
resizable = resizability;
if (resizability) {

2
modules/web/src/com/haulmont/cuba/web/AppUI.java
View File

@ -283,7 +283,7 @@ public class AppUI extends UI implements ErrorHandler {
}
/**
* For internal use only.
* INTERNAL.
*/
public void discardAccumulatedEvents() {
getRpcProxy(AppUIClientRpc.class).discardAccumulatedEvents();