类 com.telelogic.cm.migrate.MigrateObject 表示迁移过程中在源迁移路径中发现的每个对象、工作区冲突检测过程中的工作区路径或者要创建的对象在项目中的相对路径。
以下是可用方法的描述。
setName
- void setName(String name)
- 设置对象的名称。
参数:name - 对象的名称。
getType
- String getType()
- 返回对象的类型。
返回:此对象的 Rational® Synergy 类型名称(不是该类型的四部分全名,只是它的组件名称)。此方法无法返回零或空字符串。
另请参阅 setType(String)。
setType
- void setType(String type)
- throws MigrateException
- 设置对象的类型。
参数:type - 对象的类型。
抛出:MigrateException - 如果遇到。
另请参阅 getType()。
setVersion
- void setVersion(String version)
- 设置对象的版本。
参数:version - 对象的版本。
另请参阅 version()。
setDirectory
- void setDirectory(boolean isDirectory)
- 设置对象是否为目录。
参数:isDirectory - 布尔值指示对象是否为目录。
setProject
- void setProject(boolean isProject)
- 设置对象是否为项目。
参数:isProject - 布尔值指示对象是否为项目。
getAllMembers
- Collection<Member<MigrateObject>> getAllMembers()
- 返回项目对象的成员。
项目的成员是一个对象,该对象是该项目的子代,或是该项目的非项目成员的子代。由此定义可知,项目可以是其他项目的成员,但是项目的成员不一定是父项目的成员。
返回:此项目成员的无序集合(无重复项)。如果项目没有任何成员或此对象不是项目,那么该集合将为空。即,RelatedObject.isProject() 将返回 false。
getMembers
- Collection<Member<MigrateObject>> getMembers(MigrateObject
directory)
- 返回此项目中父目录的成员(绑定)。
如果当前对象不是项目,那么列表为空。
参数:directory - 需要确定其绑定的父目录。
返回:
目录中此项目成员的集合(无重复项,且按照子对象的名称进行排序)。在以下其中一种情况下,集合为空:项目没有任何成员,此源对象不是项目(即,RelatedObject.isProject() 返回 false),指定的目录没有任何成员,指定的对象不是目录。即,RelatedObject.isDirectory() 将返回 false。
getSubprojects
- Collection<MigrateObject> getSubprojects()
- 返回此迁移项目的子项目。子项目是项目形式的成员。
返回:项目对象的无序集合(无重复项)。如果此项目没有项目形式的任何成员或此对象不是项目,那么该集合为空。即,RelatedObject.isProject() 将返回 false。
getAttributes
- Map<String,Attribute> getAttributes()
- throws MigrateException
- 获取此对象的属性。
返回:将属性名作为关键字且将属性本身作为值的不可修改映射。
抛出:MigrateException - 如果遇到。
getAttribute
- Attribute getAttribute(String name)
- throws MigrateException
- 获取此对象的属性。
参数:name -
属性的名称。
返回:对应于指定名称的属性。
抛出:MigrateException - 如果遇到。
getAttributeValue
- Object getAttributeValue(String name)
- throws MigrateException
- 获取指定名称的属性值。
参数:name -
属性的名称。
返回:属性的值。
抛出:MigrateException - 如果遇到。
setAttributes
- void setAttributes(Collection<Attribute> attributes)
- 设置此对象的属性。
参数:attributes -
此对象的属性。
setAttribute
- void setAttribute(Attribute attribute)
- throws MigrateException
- 设置此对象的属性。
参数:attribute - 此对象的属性。
抛出:MigrateException - 如果遇到。
setAttribute
- void setAttribute(String name, String value)
- throws MigrateException
- 设置此对象的类型字符串的指定属性。
参数:
- name - 属性的名称。
- value - 属性的值。
抛出:MigrateException - 如果遇到。
setAttribute
- void setAttribute(String name, Date value)
- throws MigrateException
- 设置此对象的类型日期的指定属性。
参数:
- name - 属性的名称。
- value - 属性的值。
抛出:MigrateException - 如果遇到。
setAttribute
- void setAttribute(String name, boolean value)
- throws MigrateException
- 设置此对象的布尔值类型的指定属性。
参数:
- name - 属性的名称。
- value - 属性的值。
抛出:MigrateException - 如果遇到。
setAttribute
- void setAttribute(String name, int value)
- throws MigrateException
- 设置此对象的整数类型的指定属性。
参数:
- name - 属性的名称。
- value - 属性的值。
抛出:MigrateException - 如果遇到。
isBinary
- boolean isBinary()
- throws MigrateException
- 指定是将此对象的源视为文本还是视为二进制值。文本对象可以遵循关键字替换、换行转换和编码转换。二进制对象是按位进行复制且决不可变更,因为通常将它们从客户机复制到服务器并且复制到工作区或从工作区进行复制。
如果一个对象包含某些限制字符或过多控制字符,或迁移规则将其映射到二进制类型,那么此方法声明 false 的对象可能被 Rational Synergy 视为二进制对象。
返回:如果对象被视为二进制,那么返回 true,如果对象被视为文本,那么返回 false。如果此方法返回 true,但是此对象使用的 Rational Synergy 类型为 ascii 或 ascii 的子类型,那么 handle_as 属性将设置为 binary。
抛出:MigrateException - 如果遇到。
另请参阅 setBinary(boolean)。
setBinary
- void setBinary(boolean isBinary)
- 设置此对象的二进制属性。
参数:isBinary -
布尔值指示对象是否包含二进制内容。
另请参阅 isBinary()。
getTextSource
- Reader getTextSource()
- throws MigrateException
- 获取文本对象的源的访问权。如果 isBinary() 返回 false,那么迁移框架使用此方法获取源。
底层的 SourceObject# 操作负责使用正确的编码,无论底层表示在什么迁移源中。
返回:对象源的字符流。
抛出:MigrateException - 如果遇到。
setTextSource
- void setTextSource(Reader textSource)
- throws MigrateException
- 设置此对象的文本源。
参数:textSource - 此对象的文本源。
抛出:MigrateException - 如果遇到。
binarySource
- InputStream binarySource()
- throws MigrateException
- 获取对象的源的访问权。如果 isBinary() 返回 true,那么迁移框架使用此方法来获取源。
返回:对象源的字节流。
抛出:MigrateException - 如果遇到。
isExecutable
- boolean isExecutable()
- 获取文件对象上的可执行文件属性。
返回:文件是否为可执行文件。
setExecutable
- void setExecutable(boolean isExecutable)
- 设置文件对象上的可执行文件属性。
参数:isExecutable -
用于确定文件是否为可执行文件的属性。
isLink
- boolean isLink()
- 获取文件对象上的链接属性。
返回:文件是否为链接。
setLink
- void setLink(boolean isLink)
- 设置文件对象的链接属性。
参数:isLink - 用于确定文件是否为链接的属性。
isIgnore
- boolean isIgnore()
- 获取对象上的忽略属性。
返回:是否要忽略对象。
setIgnore
- void setIgnore(boolean ignore)
- 设置对象上的忽略属性。
参数:ignore - 用于确定是否忽略对象的属性。
状态
- String status()
- 获取状态属性。
返回:状态属性。
setStatus
- void setStatus(String status)
- 设置状态属性。
参数:status - 属性。
getPath
- String getPath()
- 获取该对象的路径。
返回:对象的路径。
isManualIgnore
- boolean isManualIgnore()
- 获取忽略属性。
返回:忽略属性。
setManualIgnore
- void setManualIgnore(boolean ignore)
- 设置忽略属性。
参数:ignore - 是否要忽略迁移对象。
getTaskSpec
- String getTaskSpec()
- 获取与此迁移对象相关联的任务规范。
返回:与此迁移对象相关联的任务规范。
setTaskRelease
- void setTaskRelease(String taskRelease)
- 设置要与此迁移对象相关联的任务发布。
参数:taskRelease -
要与此迁移对象相关联的任务发布。
getTaskRelease
- String getTaskRelease()
- 获取与此迁移对象相关联的任务发布。
返回:与此迁移对象相关联的任务发布。
isOptionalVersion
- boolean isOptionalVersion()
- 获取是否已设置可选版本。
返回:true/false - 根据是否已设置可选版本。
setOptionalVersion
- void setOptionalVersion(boolean isOptionalVersion)
- 设置是否已设置可选版本。
参数:isOptionalVersion -
是否已设置可选版本。
getTargetPathRelativeToTopProject
- String getTargetPathRelativeToTopProject()
- 获取相对于顶级项目的目标路径。
返回:Rational Synergy 存储库中相对于顶级项目的目标路径。