Jazz Forum Welcome to the Jazz Community Forum Connect and collaborate with IBM Engineering experts and users

How to get file properties via Java API

Questions
Tags
Users
Badges
Geoff Alexander
(196●2●39●48) edited
Apr 07 '20, 10:09 a.m.

The RTC CLI has to the "scm get property" command to get a file's property.  How can I do the same using the RTC Java API?

Update: What I actually need is a way in Java code is to do what the "scm show properties" command does, that is, get the list of file / folder properties.

0 votes

Comments
David Lafreniere
FORUM MODERATOR / JAZZ DEVELOPER Apr 07 '20, 9:40 a.m.
What properties specifically are you looking for? (there might be different API for the different properties).

Geoff Alexander
Apr 07 '20, 10:09 a.m.
Actually, what I really need is a way in Java code to do what the "scm show properties" command does.

1 answer
4,297 views
0 votes

Accepted answer

Permanent link
David Lafreniere
FORUM MODERATOR / JAZZ DEVELOPER (4.8k●7) Apr 08 '20, 7:57 a.m.
1) Get the IShareable for the file.

Ex:
            ResourceType resourceType = CommonUtil.getResourceType(path, monitor);
            if (resourceType == null) {
                // pick file as the default - doesn't exist
                resourceType = ResourceType.FILE;
            }
            IShareable shareable = SharingManager.getInstance().findShareable(path, resourceType));

2) Get the FileItemInfo.
Ex:
            FileItemInfo info = ((Shareable) shareable).getFileItemInfo(monitor);


FileItemInfo has the following properties:
-line delimiter
-encoding
-executable
-content type


Geoff Alexander selected this answer as the correct answer

1 vote

Comments
Geoff Alexander
Apr 08 '20, 9:15 a.m.
David, thanks for the answer. Is it possible to get the properties from IVersionable (actually IFileItem and IFolder), as I'm processing file / folder changes from an IChangeSet via IChangeSet.changes()?

David Lafreniere
FORUM MODERATOR / JAZZ DEVELOPER Apr 09 '20, 7:04 a.m.
The Class FileState also has the properties you care about. FileState.getContentType() FileState.getLineDelimiter(), ec. So:             IVersionableHandle handle = getVersionableHandle();             IVersionableManager versionableManager = SCMPlatform.getWorkspaceManager(getRepository()).versionableManager();             versionableState = versionableManager.fetchCompleteState(handle, monitor);         FileState fileState = ClientFileStateFactory.create(repo, versionableState .getItemType(), state);

1 vote

Geoff Alexander
Feb 08 '21, 11:00 a.m.
After upgrading from Plain Java Library 6.0 to Plain Java Library 6.0.5, ClientFileStateFactory.create() is marked deprecated.  Is there a suggested replacement for ClientFileStateFactory.create()?

David Lafreniere
FORUM MODERATOR / JAZZ DEVELOPER Feb 08 '21, 12:28 p.m.
The Javadoc indicates which method to use instead.See below:      * @deprecated           Use {@link #create(ITeamRepository, IItemType, ItemWithLinks)} instead so that the           file state includes changes to external links      */     @Deprecated     public static FileState create(ITeamRepository repo, IItemType type, IVersionable item) {

Geoff Alexander
Feb 08 '21, 12:54 p.m.
Thanks David.  I did look in the 6.0.5 Plain Java Library Javadoc, but found that there is no Javadoc for ClientFileStateFactory.  This is probably due to ClientFileStateFactory being in the internal com.ibm.team.filesystem.client.internal package.  Is there some other place I should be looking for Javadocs?

Your answer

Register or log in to post your answer.

Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.

Ask a question
Guidelines
FAQ
Search context
Follow this question

By Email: 

Once you sign in you will be able to subscribe for any updates here.

By RSS:

Answers
Answers and Comments
Question details
× 11,109

Question asked: Apr 07 '20, 9:37 a.m.

Question was seen: 4,297 times

Last updated: Mar 04 '21, 1:45 a.m.

Confirmation Cancel Confirm