[Kodi] Added dynamic state descriptions for opening pvr stream channels #3207
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /** | ||
| * Copyright (c) 2010-2018 by the respective copyright holders. | ||
| * | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| */ | ||
| package org.openhab.binding.kodi.internal; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Locale; | ||
| import java.util.Map; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.eclipse.smarthome.core.thing.Channel; | ||
| import org.eclipse.smarthome.core.thing.ChannelUID; | ||
| import org.eclipse.smarthome.core.thing.type.DynamicStateDescriptionProvider; | ||
| import org.eclipse.smarthome.core.types.StateDescription; | ||
| import org.eclipse.smarthome.core.types.StateOption; | ||
| import org.osgi.service.component.annotations.Component; | ||
| import org.osgi.service.component.annotations.Deactivate; | ||
|
|
||
| /** | ||
| * Dynamic provider of state options while leaving other state description fields as original. | ||
| * | ||
| * @author Gregory Moyer - Initial contribution | ||
| * @author Christoph Weitkamp - Adapted to Kodi binding | ||
| */ | ||
| @Component(service = { DynamicStateDescriptionProvider.class, | ||
| KodiDynamicStateDescriptionProvider.class }, immediate = true) | ||
| @NonNullByDefault | ||
| public class KodiDynamicStateDescriptionProvider implements DynamicStateDescriptionProvider { | ||
| private final Map<ChannelUID, List<StateOption>> channelOptionsMap = new ConcurrentHashMap<>(); | ||
|
|
||
| public void setStateOptions(ChannelUID channelUID, List<StateOption> options) { | ||
| channelOptionsMap.put(channelUID, options); | ||
| } | ||
|
|
||
| @Override | ||
| public @Nullable StateDescription getStateDescription(Channel channel, @Nullable StateDescription original, | ||
| @Nullable Locale locale) { | ||
| List<StateOption> options = channelOptionsMap.get(channel.getUID()); | ||
| if (options == null) { | ||
| return null; | ||
| } | ||
|
|
||
| if (original != null) { | ||
| return new StateDescription(original.getMinimum(), original.getMaximum(), original.getStep(), | ||
| original.getPattern(), original.isReadOnly(), options); | ||
| } | ||
|
|
||
| return new StateDescription(null, null, null, null, false, options); | ||
| } | ||
|
|
||
| @Deactivate | ||
| public void deactivate() { | ||
| channelOptionsMap.clear(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /** | ||
| * Copyright (c) 2010-2018 by the respective copyright holders. | ||
| * | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| */ | ||
| package org.openhab.binding.kodi.internal.model; | ||
|
|
||
| /** | ||
| * Class representing a Kodi base item | ||
| * | ||
| * @author Christoph Weitkamp - Initial contribution | ||
| */ | ||
| public abstract class KodiBaseItem { | ||
| /** | ||
| * The label of the item | ||
| */ | ||
| private String label; | ||
|
|
||
| public String getLabel() { | ||
| return label; | ||
| } | ||
|
|
||
| public void setLabel(final String label) { | ||
| this.label = label; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /** | ||
| * Copyright (c) 2010-2018 by the respective copyright holders. | ||
| * | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| */ | ||
| package org.openhab.binding.kodi.internal.model; | ||
|
|
||
| /** | ||
| * Class representing a Kodi PVR channel | ||
| * | ||
| * @author Christoph Weitkamp - Initial contribution | ||
| */ | ||
| public class KodiPVRChannel extends KodiBaseItem { | ||
| /** | ||
| * The PVR channel id | ||
| */ | ||
| private int channelId; | ||
|
There was a problem hiding this comment. Very minor, but noting slight inconsistency in naming. Here it is There was a problem hiding this comment. That's true. I think about a renaming. There was a problem hiding this comment. I thought about it and feel that my naming is OK in thus place. But I changed it in the rest of the binding to have a clear line when we talk about an ESH channel or a TV channel. |
||
| /** | ||
| * The PVR channel group id | ||
| */ | ||
| private int channelGroupId; | ||
|
|
||
| public int getId() { | ||
| return channelId; | ||
| } | ||
|
|
||
| public void setId(int channelId) { | ||
| this.channelId = channelId; | ||
| } | ||
|
|
||
| public int getChannelGroupId() { | ||
| return channelGroupId; | ||
| } | ||
|
|
||
| public void setChannelGroupId(int channelGroupId) { | ||
| this.channelGroupId = channelGroupId; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /** | ||
| * Copyright (c) 2010-2018 by the respective copyright holders. | ||
| * | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| */ | ||
| package org.openhab.binding.kodi.internal.model; | ||
|
|
||
| /** | ||
| * Class representing a Kodi PVR channel group | ||
| * | ||
| * @author Christoph Weitkamp - Initial contribution | ||
| */ | ||
| public class KodiPVRChannelGroup extends KodiBaseItem { | ||
| /** | ||
| * The PVR channel group id | ||
| */ | ||
| private int channelGroupId; | ||
|
|
||
| /** | ||
| * The PVR channel type | ||
| */ | ||
| private String channelType; | ||
|
|
||
| public int getId() { | ||
| return channelGroupId; | ||
| } | ||
|
|
||
| public void setId(final int channelGroupId) { | ||
|
There was a problem hiding this comment. Also |
||
| this.channelGroupId = channelGroupId; | ||
| } | ||
|
|
||
| public String getChannelType() { | ||
| return channelType; | ||
| } | ||
|
|
||
| public void setChannelType(final String channelType) { | ||
| this.channelType = channelType; | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FTR: this should not be done like this, see also #3292 & #3294